Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Keith Thompson authored Sep 23, 2016
1 parent c30fa00 commit 01c8e88
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# Prowl CLI

A simple CLI for sending iPhone push notifications via [prowlapp.com](prowlapp.com).

## Installation

If you have go installed you can use

```shell
$ go install github.com/keiththomps/prowl
```

If not you can pull the binary from the releases and place it in your path.

## Configuration

The CLI is designed to only be used with a single API key currently and you can configure that by using the `prowl config api` command:

```shell
$ prowl config api [YOUR API KEY]
```

The key will be stored in `~/.prowl.json` and utilized in your API requests.

## Usage

After you've added your API key to the configuration then you can send yourself a notification using the `prowl send` command:

```shell
# invoked via `prowl send [EVENT NAME] [DESCRIPTION]`
$ prowl send "Pizza Ready" "You should go eat pizza!"
```

There are more flags for `prowl send` so see `prowl send --help` for more details.

0 comments on commit 01c8e88

Please sign in to comment.