README.md in atlassian-stash-0.4.1 vs README.md in atlassian-stash-0.5.0

- old
+ new

@@ -11,12 +11,30 @@ (Protip: you might need to `sudo`) 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. If no password is provided, then you will be prompted for a password when executing commands to Stash. Currently, the password is stored in plain text in a configuration file, `~/.stashconfig.yml` which is protected with a permission bit of `0600`. +Run `stash configure`. This will prompt for details about your Stash instance. If no password is provided, then you will be prompted for a password when executing commands to Stash. +The global configuration file lives at `$HOME/.stashconfig.yml` and any options in a similarly named `.stashconfig.yml` file in the root of a git repository will take precedence. + +### Passwords +There are currently two ways to store your password in the configuration file. You may store it as plain text with the key `password`, for example: + +``` +password: s3cre7 +``` + +Or you may store a command string with the `passwordeval` key which allows you to use any encrypted method you like in order to store your password. For example, if using gpg: + +``` +passwordeval: gpg --no-tty --quiet --decrypt ~/.secret.gpg +``` + +The `stash configure` utility will not prompt you for this. If you wish to use `passwordeval`, omit a password during the configuration and add it to `~/.stashconfig.yml` afterwards. + + ### Creating a pull request Use the `pull-request` command to create a pull request in Stash. For example: ``` #!text @@ -54,10 +72,11 @@ ``` #!yaml username: seb # username to connect to stash server. password: s3cr3t # password for user. If ommitted, you will be prompted at the terminal when making a request to Stash stash_url: https://stash.server.com # fully qualified stash url +remote: upstream # Pull requests will be created in the Stash repository specified by this remote open: true # opens newly created pull requests in the browser ssl_no_verify: true # do not check ssl certificates for the configured stash server ``` ## Troubleshooting @@ -109,6 +128,6 @@ #### Releasing ``` $> rake release -``` \ No newline at end of file +```