Merge pull request #2 from Northys/master

Create README.md

README.md

@@ -0,0 +1,71 @@
+# doctrine-sortable
+
+Sooner or later you will have to implement sorting of your entities.
+For example categories, products on main page and so on. And why you should do this by yourself when everything you have to do is to copy & paste?
+
+
+Installation
+-----------
+
+The best way to install librette/doctrine-sortable is using [Composer](http://getcomposer.org/):
+
+```sh
+$ composer require librette/doctrine-sortable
+```
+
+and enable librette extension in your `config.neon
+````yml
+extensions:
+	# add this line at the end of your extensions list
+	librette.doctrine.sortable: Librette\Doctrine\Sortable\DI\SortableExtension
+```
+
+Simplest entity
+---------------
+
+
+```php
+namespace App;
+
+use Kdyby\Doctrine\Entities\BaseEntity;
+use Librette\Doctrine\Sortable\ISortable;
+use Librette\Doctrine\Sortable\TSortable;
+
+/**
+ * @ORM\Entity
+ */
+class Category extends BaseEntity implements ISortable
+{
+	use TSortable;
+	/**
+	 * @ORM\Id
+	 * @ORM\Column(type="integer")
+	 * @ORM\GeneratedValue
+	 */
+	protected $id;
+}
+```
+
+Trait TSortable
+---------------
+
+There is trait `TSortable` that implements basic sorting methods to your entity.
+Everything you need is to call those methods in your service / presenter.
+
+```php
+// you can move your entity up or down
+$entity->moveUp();
+$entity->moveDown();
+// or you can put it before / after another one
+$entity->moveBefore($anotherEntity);
+$entity->moveAfter($anotherEntity);
+// also you can set position directly
+$entity->setPosition(21);
+```
+
+**Don't forget to persist and flush after you finish with sorting!**
+
+```php
+$this->em->persist($entity);
+$this->em->flush();
+```