diff --git a/README.md b/README.md index a446bd4..36ea7c5 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,20 @@ -DigiComp.Sequence -------------------------- +# DigiComp.Sequence - -This is a very simple and stupid tool, helping in generation of gapless sequences. For this task it relies on key -integrity of the database of your choice. +This is a very simple tool, helping in generation of gapless sequences. For this task it relies on key integrity of the +database of your choice. Usage is quite simple also: +```php +/** + * @param SequenceNumberGenerator $sequenceNumberGenerator + */ +public function __construct(SequenceNumberGenerator $sequenceNumberGenerator) +{ + $this->orderId = $sequenceNumberGenerator->getNextNumberFor($this); +} +``` - /** - * @param \DigiComp\Sequence\Service\SequenceNumberGenerator $sequenceNumberGenerator - */ - public function __construct(SequenceNumberGenerator $sequenceNumberGenerator) - { - $this->orderId = $sequenceNumberGenerator->getNextNumberFor($this); - } +`getNextNumberFor` allows you to give an object (which will be resolved to its FQCN) or a custom sequence name. -``getNextNumberFor`` allows you to give an object which will be resolved to its FQCN or a custom sequence name. - -The CommandController helps you to advance the current sequence number, in case of migrations or similar. - -See ``./flow help sequence:advance`` if interested. +The `SequenceCommandController` helps you to advance the current sequence number, in case of migrations or similar. See +`./flow help sequence:advance` if interested.