Update README.md

adrexia · Feb 13, 2014 · 1806c5c · 1806c5c
1 parent e36734c
commit 1806c5c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,12 @@ http://jsplumbtoolkit.com/
 1. Enter data in a gridfield on the FlowchartPage type
 2. Manually construct drawings with that data in a ModelAdmin
 
+##Set up
+Use composer to install via Packagist or clone repo. The module name should be flowchart.
+Run dev/build?flush=all.
+
+(Note: if the modale admin appears broken, you may need to run flush=all from within the admin (module overrides edit form within a gridfield.)
+
 ## TODO
 * Better user feedback in the CMS around saving a graphical flowchart (change button names, add save and publish)
 * A better way to link to other states (treedropdown, or filtered somehow...)