Ver Fonte

update README file

Thomas há 14 anos atrás
pai
commit
5b5ed28d99
1 ficheiros alterados com 51 adições e 10 exclusões
  1. 51 10
      README.md

+ 51 - 10
README.md

@@ -1,7 +1,5 @@
-Prototype to easily create uniform backend application
-======================================================
-
-Please read the related documentation in the docs folder.
+AdminBundle - The missing Symfony2 Admin Generator
+==================================================
 
 *WARNING* : this is a prototype, and not a final/stable bundle.
 
@@ -10,12 +8,55 @@ Please read the related documentation in the docs folder.
    - code might change with no notices.
 
 
+Quick example
+-------------
+
+
+Defining an ``Admin`` class is pretty easy: simply define fields as properties
+
+    class PostAdmin extends Admin
+    {
+        protected $form = array(
+            'author' => array('edit' => 'list'),
+            'enabled' => array('form_field_options' => array('required' => false)),
+            'title',
+            'abstract',
+            'content',
+            'tags'     => array('form_field_options' => array('expanded' => true)),
+            'commentsCloseAt',
+            'commentsEnabled' => array('form_field_options' => array('required' => false)),
+        );
+
+        protected $list = array(
+            'title' => array('identifier' => true),
+            'author',
+            'enabled',
+            'commentsEnabled',
+        );
+
+        protected $filter = array(
+            'title',
+            'author',
+            'enabled',
+        );
+    }
+
+Screenshots : http://www.dropbox.com/gallery/581816/2/BaseApplicationBundle/preview?h=59b2e8
+
+Of course, power users will be happy as an ``Admin`` class is very flexible as all dependencies are
+injected by the DIC.
+
+
+More information
+----------------
 
-TODO :
+You need to go to the Ressources/doc folder where the reStructuredText documentation is available.
+Please note the Github preview might break and hide some content.
 
-   - use the admin class to register route information (done)
-   - edit group field (done)
-   - add inline editing (Invoice with InvoiceLine) (done)
-   - save filter criteria
-   - export list
+TODO
+----
 
+  - create the ODM version
+  - refactor the datagrid
+  - save filter criteria
+  - export list