-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
220609d
commit 19db622
Showing
1 changed file
with
15 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |