diff options
| author | Teddy Wing | 2016-09-12 04:31:03 -0400 |
|---|---|---|
| committer | Teddy Wing | 2016-09-12 04:31:03 -0400 |
| commit | 34cd3cdaccbfe3408e83b9063490843569b9c4eb (patch) | |
| tree | 28ca4b5df019aabc11ade550d353929ce655df34 /README.md | |
| parent | a80ab1125b88ec710812585760a72e75943af6c0 (diff) | |
| download | irssi-slack-profile-34cd3cdaccbfe3408e83b9063490843569b9c4eb.tar.bz2 | |
Add README
Include a short description, Slack API key configuration settings, usage
information, sample output, and license information.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..fd45d4e --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +irssi-slack-profile +=================== + +An Irssi plugin that provides WHOIS-style profile information about Slack +users. + + +## Configuration +In order to use this script, a Slack API token _must_ be configured to request +user profile information. A token can be obtained from +https://api.slack.com/docs/oauth-test-tokens. Add it with: + + /set slack_profile_token TOKEN + + +## Usage +To query a user's profile, run the `/swhois` command with their nick: + + /swhois nick + /swhois @nick + +The resulting output will appear as: + + 00:00 -!- Irssi: nibbler + 00:00 -!- Irssi: name : Lord Nibbler + 00:00 -!- Irssi: email : nibbler@example.com + 00:00 -!- Irssi: phone : 2125553455 + 00:00 -!- Irssi: tz : Eastern Daylight Time + 00:00 -!- Irssi: End of SWHOIS + + +## License +Copyright © 2016 Teddy Wing. Licensed under the GNU GPLv3+ (see the included +COPYING file). |