Skip to content

Commit

Permalink
Merge pull request #12 from patrickbeeson/master
Browse files Browse the repository at this point in the history
Add additional description to PATH and account configuration.
  • Loading branch information
leonbarrett committed Aug 14, 2014
2 parents 697ef5a + 0ef667b commit 548714c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions readme.markdown
Expand Up @@ -25,6 +25,8 @@ Either place it in your path, or add to your path.

`echo 'export PATH=YOURPATHHERE:$PATH' >> ~/.profile`

For example, if you placed "beanstalk" in a directory called "bin" in your home directory, your path might be: `/Users/<your_username>/bin`.

When using the tool for the 1st time you will be prompted to add in your Beanstalk details.

You can also add a beanstalk_cli.config to your home directory containing:
Expand All @@ -34,6 +36,8 @@ account = ACCOUNT_NAME
username = USER_NAME
password = PASSWORD`

*Note: Your account name should be as it appears in your Account URL, not the actual "company name."*

If you want to store your Beanstalk password in your Keychain rather than in plain text you can read the guide on the Wiki - https://github.com/leonbarrett/BeanstalkCommandLine/wiki/Using-Keychain

Type `beanstalk --help` for help.
Expand Down

0 comments on commit 548714c

Please sign in to comment.