Skip to content

Commit

Permalink
adds Setup section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremy-w committed Mar 12, 2013
1 parent 0f93043 commit dcd9f9d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.markdown
Expand Up @@ -30,6 +30,25 @@ Redminer depends on the OS X keychain for storage of your login info,
and on your sufferance for its continued existence.
It begs a thousand pardons that it should be so ugly and yet live.

## Setup
Add a new Internet password named "redmine" with the correct host.
Add "api: <yourkey>" to the comments field.

Using Keychain.app:

- Choose File > New Password, or just hit Cmd-N.
- First field is the web address of your Redmine host (include the http:// or
https:// part).
- Second field is your Redmine username.
- Third field is your Redmine account password.
- Now add the password entry to the Keychain using the button in the lower
right.

- Now double-click to edit the password:
- Change the name to just "redmine".
- In the Comments field, put "api: 1234…abcd", replacing the part after
"api: " with your API key.

## Todo
* Non-fugly user interface. (YAML hash dump? Really?)
* An actual user interface supporting flags and some flexibility,
Expand Down

0 comments on commit dcd9f9d

Please sign in to comment.