README.md in wpb-0.0.6.pre vs README.md in wpb-0.0.6

- old
+ new

@@ -1,9 +1,16 @@ # WPB (WordPress Bash) ## About -WPB (aka WordPress Bash) provides a Terminal interface to WordPress. It tries to achieve a similar feel to irb and the rails console. -For example working with users you will be able to do something like this -```ruby -wpb:01> User.find 1 - => #<WPB::UserObject:0x0000010087ef78 @name="James Birtles", @username="jamesbirtles"> -``` +WPB allows you to access your wordpress database through the console in a similar way to the rails console. + +## Install +```sh +gem install wpb +``` + +## Troubleshooting +* Make sure you have mysql installed on your machine for the mysql gem to install, you also need some kind of compiler + * For mac, you need xcode and homebrew and you can install mysql as follows. `brew install mysql` + +## Contributing +* Fork the [git repo](http://github.com/jamesbirtles/WPB) \ No newline at end of file