Skip to content

Commit

Permalink
docs: minor README cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
mroth committed Jul 21, 2020
1 parent 2f78837 commit 4badceb
Showing 1 changed file with 22 additions and 10 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
# slacknimate
> text animation for Slack messages :dancers:
> Realtime text animation for Slack messages :dancers:
Useful for ChatOps:
![deployinator](https://cloud.githubusercontent.com/assets/40650/26273321/0cd49fda-3cfc-11e7-90ce-78f369e783ac.gif)
## Primary use case: ChatOps

![deployinator-example](https://cloud.githubusercontent.com/assets/40650/26273321/0cd49fda-3cfc-11e7-90ce-78f369e783ac.gif)

## Alternative uses

...Or for comedy:
While slacknimate is primarily intended for ChatOps, it has become popular
for... other use cases.

![slacknimate_fine2](https://cloud.githubusercontent.com/assets/40650/26273332/613cc17e-3cfc-11e7-9365-88b0043c17ef.gif)
...Such as comedy:

![thisisfine-example](https://cloud.githubusercontent.com/assets/40650/26273332/613cc17e-3cfc-11e7-9365-88b0043c17ef.gif)

...Or maybe art:

![slacknimate_nyan](https://cloud.githubusercontent.com/assets/40650/26273350/ad3b0d56-3cfc-11e7-9359-83c92f440a03.gif)
![nyancat-example](https://cloud.githubusercontent.com/assets/40650/26273350/ad3b0d56-3cfc-11e7-9359-83c92f440a03.gif)


## Installation
Download a binary from the [Releases Page](https://github.com/mroth/slacknimate/releases) and put it somewhere on your `$PATH`.

_macOS Homebrew users, you can also just `brew install slacknimate`._
Simply download a binary for your OS/architecture from the [Releases
Page](https://github.com/mroth/slacknimate/releases) and put it somewhere on
your `$PATH`.

_Homebrew users, you can also just `brew install slacknimate`._

## Authentication
Generate your Slack app and generate an API token. The app will need appropriate
OAuth scopes to post messages to your desired destination.

Generate your Slack app and generate an API token. Note that the app will need
appropriate OAuth scopes to post messages to your desired destination.

You'll need to either pass it to the program via the `--api-token` flag or store
it as `SLACK_TOKEN` environment variable.
Expand Down Expand Up @@ -52,13 +60,16 @@ GLOBAL OPTIONS:
--version, -v print the version (default: false)
```

You can also use Slacknimate directly via the [Go package](https://godoc.org/github.com/mroth/slacknimate).

### Simple animation loops

$ slacknimate -c "#general" --loop < examples/emoji.txt

![slacknimate1](https://cloud.githubusercontent.com/assets/40650/13275355/32f5997c-da82-11e5-8a9d-61c53f94c718.gif)

### Realtime process monitoring

Why spam a chatroom with periodic monitoring messages when you can have realtime
status updates so that a message is never out of date?

Expand All @@ -80,6 +91,7 @@ Done!


### Preview in terminal

If you aren't certain about your source, you can preview what the animation
would look like in the terminal via the `--preview` flag.

Expand Down

0 comments on commit 4badceb

Please sign in to comment.