Merge pull request #118 from mrkaye97/master

update readme to fix bullets
mrkaye97 · Dec 13, 2020 · ac644de · ac644de
2 parents 90b9a88 + 4bf9bd7
commit ac644de
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 11 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -85,6 +85,7 @@ You can also change the default emoji icon (from the one you setup at integratio
 ### Scopes
 
 You will need to have the following Bot Token Scopes enabled:
+
 * `channels:read`
 * `users:read`
 * `files:read`
@@ -94,7 +95,7 @@ You will need to have the following Bot Token Scopes enabled:
 * `im:write`
 * `incoming-webhook`
 
-Without these scopes, only certain functions will work.
+Without these scopes, only certain functions will work. Which ones depends on which scopes you have enabled.
 
 ### Private Channels
 
@@ -151,6 +152,7 @@ ggslackr(qplot(mpg, wt, data=mtcars))
 ### Known Issues
 
 * Depending on your scopes, `slackr` could quietly fail (i.e. not throw an error, but also not post anything to your channel). If this happens, try explicitly adding the `slackr` app to your channel in your Slack workspace.
+* Private channels are not seen by `slackr` in some cases.
 
 ### Test Results
 

diff --git a/README.md b/README.md
@@ -113,12 +113,19 @@ integration creation time) with `icon_emoji`.
 
 ### Scopes
 
-You will need to have the following Bot Token Scopes enabled: \*
-`channels:read` \* `users:read` \* `files:read` \* `chat:write` \*
-`chat:write.customize` \* `chat:write.public` \* `im:write` \*
-`incoming-webhook`
+You will need to have the following Bot Token Scopes enabled:
 
-Without these scopes, only certain functions will work.
+-   `channels:read`
+-   `users:read`
+-   `files:read`
+-   `chat:write`
+-   `chat:write.customize`
+-   `chat:write.public`
+-   `im:write`
+-   `incoming-webhook`
+
+Without these scopes, only certain functions will work. Which ones
+depends on which scopes you have enabled.
 
 ### Private Channels
 
@@ -179,6 +186,7 @@ example](https://github.com/yonicd/texPreview/blob/master/.github/workflows/R-ma
     throw an error, but also not post anything to your channel). If this
     happens, try explicitly adding the `slackr` app to your channel in
     your Slack workspace.
+-   Private channels are not seen by `slackr` in some cases.
 
 ### Test Results
 
@@ -189,20 +197,18 @@ example](https://github.com/yonicd/texPreview/blob/master/.github/workflows/R-ma
     slackrSetup()
 
     date()
-    #> [1] "Sun Dec 13 10:03:50 2020"
+    #> [1] "Sun Dec 13 17:37:39 2020"
 
     devtools::test()
     #> Loading slackr
     #> Testing slackr
     #> ✓ |  OK F W S | Context
-    #> ⠏ |   0       | slackr                                                                                                  ⠏ |   0       | slackr                                                                                                  ⠋ |   1       | slackr                                                                                                  ✓ |   1       | slackr [0.5 s]
+    #> ⠏ |   0       | slackr                                                                                                  ⠏ |   0       | slackr                                                                                                  ⠋ |   1       | slackr                                                                                                  ✓ |   1       | slackr [0.6 s]
     #> 
     #> ══ Results ═════════════════════════════════════════════════════════════════════════════════════════════════════════════
-    #> Duration: 0.5 s
+    #> Duration: 0.7 s
     #> 
     #> [ FAIL 0 | WARN 0 | SKIP 0 | PASS 1 ]
-    #> 
-    #> 🧿 Your tests look perfect 🧿
 
 ### Onexit Usage