aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorA. Jesse Jiryu Davis <jesse@mongodb.com>2018-01-17 19:13:03 -0500
committerA. Jesse Jiryu Davis <jesse@mongodb.com>2018-01-17 19:13:50 -0500
commit9835feea622489d77899dd93a3c01a950d6e7edb (patch)
tree8aea6fbc3464b2c11bfe2b884fb41a5e13232de8
parent5330bda24d919a111b0ddea8d84f5cbb0c5ef953 (diff)
downloadwee-slack-9835feea622489d77899dd93a3c01a950d6e7edb.tar.gz
update README for new /slack register command
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index ace8980..a06b328 100644
--- a/README.md
+++ b/README.md
@@ -88,10 +88,35 @@ weechat
**NOTE:** If weechat is already running, the script can be loaded using ``/python load python/autoload/wee_slack.py``
#### 4. Add your Slack API key(s)
+
+Log in to Slack:
+
+```
+/slack register
+```
+
+This command opens your browser and prompts you to authorize WeeChat with Slack.
+Once you've accomplished this, copy the "code" portion of the URL in the browser
+and pass it to this command:
+
+```
+/slack register [YOUR_SLACK_TOKEN]
+```
+
+Your Slack team is now added, and you can complete setup by restarting the
+wee-slack plugin.
+
+```
+/python reload slack
+```
+
+Alternatively, you can click the "Request token" button at the
+[Slack legacy token page](https://api.slack.com/custom-integrations/legacy-tokens),
+and paste it directly into your settings:
+
```
/set plugins.var.python.slack.slack_api_token [YOUR_SLACK_TOKEN]
```
-^^ (find this at https://api.slack.com/custom-integrations/legacy-tokens using the "Request token" button)
If you don't want to store your API token in plaintext you can use the secure features of weechat: