README.md in atlassian-stash-0.1.1 vs README.md in atlassian-stash-0.1.2
- old
+ new
@@ -1,17 +1,42 @@
-Atlassian Stash CLI
-===================
+# Atlassian Stash Command Line Tools
+## Installing this tool
+This command line helper for Stash is written in Ruby and is deployed as a [Ruby Gem](https://rubygems.org/gems/atlassian-stash/). Installation is easy, simply run the following command
-Build instructions
-------------------
-1. gem install bundler
-2. bundle install
+ $> gem install atlassian-stash
-Configuration
--------------
-1. run `stash setup`
-2. Setup a Git alias! ``git config --global alias.create-pull-request "stash pull-request \"\$0\""``
-3. From your git repository, run `git create-pull-request master` to create a pull request from your current branch to master
+(Protip: you might need to `sudo`)
-See the usage help for more information by running
+Once the gem is installed, the command `stash` will be in your `$PATH`
+
+## Configuration and usage
+Run `stash configure`. This will prompt for details about your Stash instance.
+
+### Creating a pull request
+Use the `pull-request` command to create a pull request in Stash. E.g:
+
+ $> stash pull-request topicBranch master @michael
+ Create a pull request from branch 'topicBranch' into 'master' with 'michael' added as a reviewer
+
+See the usage for command details
+
stash help
+
+## Troubleshooting
+Q: I installed the gem, but the `stash` command doesn't work.
+A: Do you have another command called `stash` or do you have an alias? Have a look where the command maps to
+
+ $> which -a stash
+
+Then check the value of your $PATH
+
+## I want to contribute
+Thanks! Please [fork this project](https://bitbucket.org/atlassian/atlassian-stash-rubygem/fork) and create a pull request to submit changes back to the original project.
+
+### Build instructions
+Building this gem is easy. To get started, run the following commands:
+
+ $> gem install bundler
+ $> bundler install
+
+Now start hacking, and run the stash command by invoking `./bin/stash command`