README.md in bonethug-0.0.18 vs README.md in bonethug-0.0.20
- old
+ new
@@ -21,11 +21,11 @@
Usage
-----
-### Commands
+### Local Commands
**Set up a project Skeleton**
@@ -33,19 +33,57 @@
**Add bonethug to an existing project **
-if you just want to use the deploy / cron / backup framework
+*If you just want to use the deploy / cron / backup framework*
`bonethug init`
-**update the bonethug files in an existing project**
+**Update the bonethug files in an existing project**
-`bonethug update`
-
+*This updates the .bonethug/deploy.rb, .bonethug/backup.rb,
+config/example/cnf.yml, config/example/schedule.rb config files*
+
+`bonethug update`
+
+
+
+**Watch for changes to SCSS / CoffeeScript**
+
+*Configure the watch in the config/cnf.yml. Uses sprockets by default, but can
+use vanilla coffeescript and sass compilers if you pass it the coffee_sass
+argument*
+
+`bonethug watch [coffee_sass]`
+
+
+
+### Remote Commands
+
+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 off the checking by adding the
+following to ~/.ssh/config.
+
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Host *
+ StrictHostKeyChecking no
+ UserKnownHostsFile=/dev/null
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+**Setup and Deploy to Remote Server**
+
+*This wraps mina and deploys using the information contained in cnf.yml*
+
+`bonethug setup {develoment|staging|production}`
+`bonethug deploy {develoment|staging|production}`
Contributing
------------