Skip to content

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chrislo committed Dec 4, 2009
1 parent e51f44e commit 8aa741b
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
= jira

Description goes here.
A command line interface to the Jira issue tracking system.

To use, create a '.jira' YAML file in your home directory. For example:

:jira_base: https://jira.your.domain
:pem: ~/yourcert.pem

The 'pem' parameter is optional, but required if your jira
installation uses SSL authentication. If you connect to Jira through a
proxy set the HTTP_PROXY environment variable.

To get a list of unopened tickets assigned to you:

$ jira list

== Note on Patches/Pull Requests

Expand All @@ -9,8 +22,6 @@ Description goes here.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but
bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

== Copyright
Expand Down

0 comments on commit 8aa741b

Please sign in to comment.