Skip to content

Commit

Permalink
adding READMD
Browse files Browse the repository at this point in the history
  • Loading branch information
addisonhuddy committed Aug 14, 2017
1 parent 220609d commit 19db622
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Autobeat
A tool for making the creation of update emails a little easier

## Installation
To install from source, simply `go install github.com/addisonhuddy/autobeat`. This assumes you have the Go toolchain installed.

Or use the OS X or Linux binaries on the Github release page.

## Usage

`autobeat -project=[PROJECT ID] -key=[TRACKER API KEY] -jira=[url to JIRA issues]`

Default JIRA url is https://issues.apache.org/jira/browse/.

The above command will produce `autobeat.md` in the same directory. Edit and use a tool like [Markdown Here](http://markdown-here.com/) to make sending update emails a breeze.

0 comments on commit 19db622

Please sign in to comment.