README.md in bonethug-0.0.63 vs README.md in bonethug-0.0.66

@@ -1,14 +1,29 @@
 Bonethug
 ========
 
 
 
-Project Skeleton Manager
+(Project) Bones in the basement and a thug to do the things you don't want to
+dirty your hands with.
 
 
 
+Bonethug could loosely be considered a "web project meta framework".  It uses a
+single configuration file (although it merges in the database.yml file for rails
+projects) for all project types and includes adapters to interface with project
+specific configs.  This keeps you configuration in one place and has the benefit
+of being able to drive the automation of a number of other repeatitious taks
+like deployment, task scheduling, backups and asset / db synchronisation.
+
+
+
+The goal of the project is to be able to handle the complete project life cycle
+using only bonethug, git and package managers - no ssh, ftp, mysqldump etc.
+
+
+
 Installation
 ------------
 
 Add this line to your application's Gemfile:
 
@@ -23,11 +38,11 @@
     `gem install bonethug`
 
 
 
 Update
-------------
+------
 
 execute:
 
     `bundle update bonethug`
 
@@ -46,11 +61,11 @@
 
 
 
 **Set up a project Skeleton**
 
-`thug install {rails3|silverstripe3|drupal|php|sinatra}`
+`thug install {rails3|rails4|silverstripe3|drupal|php|sinatra}`
 
 
 
 **Add bonethug to an existing project**
 
@@ -85,13 +100,31 @@
 
 `thug local-backup {development|staging|production}`
 
 
 
+**Setup local server**
+
+*You sets up the local machine (if you are on ubuntu)*
+
+`thug setup-env local`
+
+
+
+**Initialise local DB**
+
+*Uses the local mysql client to create a user and a database according to the
+settings in your config/cnf.yml file*
+
+`thug init-local-db [admin_user=root] {development|staging|production}`
+
+
+
 ### Remote Commands
 
-*UPDATE:* Bonethug now supports interactive prompts so this may no longer be necessary
+*UPDATE:* Bonethug now supports interactive prompts so this may no longer be
+necessary
 
 Most of these are piped through mina.  Mina uses SSH to send a bash script to
 the remote server where it is executed.  For these commands to work you need to
 have the desired host already added to your known hosts file: ~/.ssh/known_hosts
 which means you can either connect to the host first, manually add it or switch
@@ -103,20 +136,36 @@
 Host *
     StrictHostKeyChecking no
     UserKnownHostsFile=/dev/null
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+
+
 **Setup a remote server**
 
-*This wraps mina to call all the commandsThis installs all the required software on a remote server*
-`thug setup_env {development|staging|production}`
+*This installs all the required software on a remote server using mina to call
+all the commands*
 
+`thug setup-env {development|staging|production}`
+
+
+
+**Initialise remote DB**
+
+*Uses the mysql client in the remote environment to create a user and a database
+according to the settings in your config/cnf.yml file*
+
+`thug init-db [admin_user=root] {development|staging|production}`
+
+
+
 **Setup and Deploy to Remote Server**
 
 *This wraps mina and deploys using the information contained in cnf.yml*
 
-`thug setup {development|staging|production}`  
+`thug setup {development|staging|production}`
+
 `thug deploy {develoment|staging|production}`
 
 
 
 **Trigger a Snapshot Backup from the Remote Server**
@@ -144,16 +193,126 @@
 
 `thug sync-from {develoment|staging|production}`
 
 `thug sync-to {develoment|staging|production}`
 
-  
 
 
+Example Workflow
+----------------
+
+
+
+### New SilverStripe3 project
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# install bonethug in the global scope (or use: bundle exec thug)
+gem install bonethug
+
+# set up project bones in the current folder
+thug install silverstripe3
+bundle install --path vendor
+php composer.phar install
+bower install
+
+# --> edit the config/cnf.yml file!!
+
+# watch for changes to sass and coffeescript
+thug watch
+
+# --> actually write some code!!
+
+# commit work
+git remote add origin [e-mail]:namespace/project-name.git
+git add -A && git commit -am "initial commit"
+git push -u origin master
+
+# setup the deployment env and do a deploy
+thug auth staging
+thug setup-env staging
+thug init-db staging
+thug setup staging
+thug deploy staging
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+### Deploying an existing project
+
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# clone the repo and install the gems
+git clone [e-mail]:namespace/project-name.git .
+bundle install --path vendor
+
+# only do this if its a fresh deploy target
+thug auth staging
+thug setup-env staging
+thug init-db staging
+thug setup staging
+
+# deploy
+thug deploy staging
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+What isn't implemented yet?
+---------------------------
+
+
+
+### Setup an existing project and mirror a remote environment (WIP)
+
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# clone the repo and install the gems
+git clone [e-mail]:namespace/project-name.git .
+bundle install --path vendor
+
+# setup local db
+thug init-local-db staging
+
+# add ssh key
+thug auth staging
+
+# do file sync
+thug sync-from staging
+
+# do db sync
+thug sync-local-db staging development
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+### Push local assets etc to a remote (WIP)
+
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# add ssh key
+thug auth staging
+
+# do file sync
+thug sync-to staging
+
+# do db sync
+thug sync-remote-db development staging
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
 Contributing
 ------------
 
-1.  Fork it 
-2.  Create your feature branch (`git checkout -b my-new-feature`) 
-3.  Commit your changes (`git commit -am 'Add some feature'`) 
-4.  Push to the branch (`git push origin my-new-feature`) 
+1.  Fork it
+
+2.  Create your feature branch (`git checkout -b my-new-feature`)
+
+3.  Commit your changes (`git commit -am 'Add some feature'`)
+
+4.  Push to the branch (`git push origin my-new-feature`)
+
 5.  Create new Pull Request