Merge pull request #8 from compwright/master

Readme cleanups

Author: Alexandre

README.md

@@ -1,8 +1,39 @@
 PhpDbMigration - full PHP database migration tool
 =================================================
 
-This is a full standalone PHP tool based on symfony console and inspired by the rails database migration tool and MyBatis.
-It merge the functionnality of the two tools and has been desined to be as flexible as possible.
+This is a full standalone PHP tool based on [Symfony Console](http://symfony.com/doc/current/components/console)
+and inspired by the Rails database migration tool and MyBatis. It merges the functionality of the two tools and
+has been designed to be as flexible as possible.
+
+Usage
+-----
+```
+$ ./bin/migrate
+Console Tool
+
+Usage:
+  command [options] [arguments]
+
+Options:
+  -h, --help            Display this help message
+  -q, --quiet           Do not output any message
+  -V, --version         Display this application version
+      --ansi            Force ANSI output
+      --no-ansi         Disable ANSI output
+  -n, --no-interaction  Do not ask any interactive question
+  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
+Available commands:
+  help            Displays help for a command
+  list            Lists commands
+ migrate
+  migrate:addenv  Initialise an environment to work with php db migrate
+  migrate:create  Create a SQL migration
+  migrate:down    Rollback all waiting migration down to [to] option if precised
+  migrate:init    Create the changelog table on your environment database
+  migrate:status  Display the current status of the specified environment
+  migrate:up      Execute all waiting migration up to [to] option if precised
+```
 
 Installing it to your project
 -----------------------------
@@ -30,19 +61,29 @@ Adding an environment
 ---------------------
 The first thing to do before playing with SQL migrations is to add an environment, let's add the dev one.
 
-![alt tag](http://tikotepadventure.com/files/php-database-migration/addenv.gif)
+```
+$ ./bin/migrate migrate:addenv
+```
+
+You will be prompted to answer a series of questions about your environment, and then a config file will be saved
+in `./.php-database-migration/environments/[env].yml`.
 
 Initialization
 --------------
-Once the environment is added, you have to initialize it (create the changelog table on the good database) 
+Once the environment is added, you have to initialize it. This verifies that the database connection works, and
+create a new database table for tracking the current database changes:
 
-![alt tag](http://tikotepadventure.com/files/php-database-migration/init.gif)
+```
+$ ./bin/migrate migrate:init [env]
+```
 
 Create a migration
 ------------------
 It is time to create our first migration file.
 
-![alt tag](http://tikotepadventure.com/files/php-database-migration/create.gif)
+```
+$ ./bin/migrate migrate:create [env]
+```
 
 Migrations file are like this
 
@@ -54,14 +95,21 @@ Migrations file are like this
     drop table users;
 
 Up and down
-------------------
+-----------
 You can now up all the pending migrations. If you decided to down a migration, the last one will be downed alone to prevent from mistake. You will be asked to confirm the downgrade of your database before runing the real SQL script. 
-![alt tag](http://tikotepadventure.com/files/php-database-migration/status.gif)
 
-For developement purpose, it is also possible to up a single migration without taking care of the other ones.
+```
+$ ./bin/migrate migrate:up [env]
+```
+
+For developement purpose, it is also possible to up a single migration without taking care of the other ones:
 
-![alt tag](http://tikotepadventure.com/files/php-database-migration/uponly.gif)
+```
+$ ./bin/migrate migrate:up [env] --only=[migration]
+```
 
-Same thing for down
+Same thing for down:
 
-![alt tag](http://tikotepadventure.com/files/php-database-migration/downonly.gif)
+```
+$ ./bin/migrate migrate:down [env] --only=[migration]
+```