Readme: sync

contributte · May 19, 2018 · c81d247 · c81d247
1 parent d33f25e
commit c81d247
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 24 deletions.
diff --git a/.docs/README.md b/.docs/README.md
@@ -1,6 +1,12 @@
 # Nextras\ORM Query Objects
 
-## Toc
+## Content
+
+- [Usage - how use it](#usage)
+    - [Simple Query Object](#simple-query-object)
+    - [Full Query Object](#full-query-object)
+    - [Executable Query Object](#executable-query-object)
+    - [Query Object Manager](#query-object-manager)
 
 ## Usage
 
@@ -10,10 +16,6 @@
 final class SimpleQueryObject extends QueryObject
 {
 
-    /**
-     * @param QueryBuilder $builder
-     * @return QueryBuilder
-     */
     public function doQuery(QueryBuilder $builder)
     {
         return $builder->select('*')->from('foobar');
@@ -24,7 +26,7 @@ final class SimpleQueryObject extends QueryObject
 
 ```php
 $qo = new SimpleQueryObject();
-$qom = new QueryObjectManager();
+$qom = $container->getByType(QueryObjectManager::class);
 $result = $qom->fetch($qo);
 ```
 
@@ -35,19 +37,11 @@ $result = $qom->fetch($qo);
 final class FullQueryObject extends QueryObject
 {
 
-    /**
-     * @param QueryBuilder $builder
-     * @return QueryBuilder
-     */
     public function doQuery(QueryBuilder $builder)
     {
         return $builder->select('*')->from('foobar');
     }
 
-    /**
-     * @param QueryBuilder $builder
-     * @return QueryBuilder
-     */
     protected function postQuery(QueryBuilder $builder)
     {
         return $builder;
@@ -58,7 +52,7 @@ final class FullQueryObject extends QueryObject
 
 ```php
 $qo = new FullQueryObject();
-$qom = new QueryObjectManager();
+$qom = $container->getByType(QueryObjectManager::class);
 $result = $qom->fetch($qo);
 ```
 
@@ -69,19 +63,11 @@ $result = $qom->fetch($qo);
 final class SimpleExecutableQueryObject extends ExecutableQueryObject
 {
 
-    /**
-     * @param QueryBuilder $builder
-     * @return QueryBuilder
-     */
     public function doQuery(QueryBuilder $builder)
     {
         return $builder->select('*')->from('foobar');
     }
 
-    /**
-     * @param Result $result
-     * @return Result
-     */
     protected function postResult(Result $result)
     {
         return $result;

diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ composer require contributte/nextras-orm-query-object
 
 ## Overview
 
-- [Usage - how to register](https://github.com/contributte/nextras-orm-query-object/blob/master/.docs/README.md#usage-tada)
+- [Usage - how to use it](https://github.com/contributte/nextras-orm-query-object/blob/master/.docs/README.md#usage)
 
 ## Maintainers