Bladeren bron

update README

Thomas Rabaix 14 jaren geleden
bovenliggende
commit
0571c5bb6a
1 gewijzigde bestanden met toevoegingen van 46 en 10 verwijderingen
  1. 46 10
      README.md

+ 46 - 10
README.md

@@ -1,17 +1,9 @@
 AdminBundle - The missing Symfony2 Admin Generator
 ==================================================
 
-*WARNING* : this is a prototype, and not a final/stable bundle.
-
-   - code can be irrelevant
-   - code might not use properly Symfony2 or Doctrine components
-   - code might change with no notices.
-
-
 Quick example
 -------------
 
-
 Defining an ``Admin`` class is pretty easy: simply define fields as properties
 
     class PostAdmin extends Admin
@@ -46,17 +38,61 @@ Screenshots : http://www.dropbox.com/gallery/581816/2/BaseApplicationBundle/prev
 Of course, power users will be happy as an ``Admin`` class is very flexible as all dependencies are
 injected by the DIC.
 
+Features
+--------
+
+  - Dashboard
+
+  - List
+
+    - Automatic sort
+    - Link to associated admin (Post => User)
+    - Custom templates
+    - Row Action : edit, view, ...
+    - Batch Action
+    - Clever row visualisation : boolean values are represented with 'check picture'
+    - Filter
+    - Pagination
+
+  - Edit/Create
+
+    - Inline edition
+    - Association management (create related model with + icon)
+    - Group fields
+    - Sortable option
+    - Modal window to select model (when the list can be important)
+    - Dynamic form on [one|many]-to-many association (add new element)
+
+  - Templating
+
+    - base templates (field, list, filter) can be overwritten
+    - layout templates can be defined into the Service Container
+
+  - Others
+
+    - Nested Admin, ie /news/post/5/comment/list : filter and create comments only for the post with id=5
+    - Contextual Breadcrumb
+    - persistent parameters across an Admin
+    - side menu option
+    - Translated into 7 languages : DE, EN, ES, FR, NL, PL and RU.
+    - Built to be extended
+
 
 More information
 ----------------
 
-You need to go to the Ressources/doc folder where the reStructuredText documentation is available.
+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.
 
+Usage examples
+
+ - https://github.com/sonata-project/MediaBundle
+ - https://github.com/sonata-project/NewsBundle
+ - https://github.com/sonata-project/UserBundle (custom fork of FOS/UserBundle)
+
 TODO
 ----
 
   - create the ODM version
-  - refactor the datagrid
   - save filter criteria
   - export list