Update Readme

geggleto · Oct 28, 2017 · b5712e6 · b5712e6
1 parent 025d431
commit b5712e6
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,3 +2,14 @@
 
 # skelly
 Admin Project Bootstrap
+
+## Installation
+
+`php composer.phar create-project geggleto/skelly [my-app-name]`
+
+## Configuration
+
+1. Copy `config/.env.sample` to `config/.env` and fill in the details
+2. Use `composer db` to sync the database schema
+3. Create your users, `php cli/newUser.php <email> <password> <firstName> <lastName>`
+4. Login and Build!
diff --git a/composer.json b/composer.json
@@ -16,7 +16,8 @@
     },
     "scripts" : {
         "gulp": "cd public/assets && npm install && gulp",
-        "post-install-cmd": "@gulp"
+        "post-install-cmd": "@gulp",
+        "db" : "vendor/bin/doctrine orm:schema-tool:update --force"
     },
     "autoload" : {
         "psr-4" : {