docs: add example and auth flow

mtliendo · Jun 27, 2018 · 803106c · 803106c
1 parent 51c5bf2
commit 803106c
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,6 +17,9 @@ lib-cov
 # Coverage directory used by tools like istanbul
 coverage
 
+# github pages cache data
+.DS_Store
+
 # nyc test coverage
 .nyc_output
 

diff --git a/README.md b/README.md
@@ -1,2 +1,44 @@
-# slack-clapback
-GET 👏🏾SASSY👏🏾WITH👏🏾YOUR👏🏾SENTENCE👏🏾
+# SLACK CLAPBACK
+
+<p align="center">
+  ADD👏🏾SOME👏🏾SASS👏🏾TO👏🏾YOUR👏🏾SENTENCE!👏🏾
+  <img src='./images/sassy.jpg'/>
+</p>
+
+## Reason behind this app
+
+Using [Slack](https://slack.com/)? Enjoy a good [clapback](https://www.urbandictionary.com/define.php?term=clapback)? Then this application is a must!
+
+I found myself always typing
+
+`I👏🏾GOT👏🏾YOUR👏🏾BACK!👏🏾` in Slack.  Now granted, Slack makes it easy to add emojis, but I wanted to be more productive 😉
+
+Using the `/clapback` [slash command](https://api.slack.com/slash-commands), users in all channels can have the words in their sentence(s) transformed to automatically be more sassy!
+
+Example:
+
+![EXAMPLE](./images/clapback-example.gif)
+
+---
+
+## Usage
+
+Install the app by clicking this button:
+
+<a href="https://slack.com/oauth/authorize?client_id=2350673601.387252996256&scope=commands,chat:write:bot"><img alt="Add to Slack" height="40" width="139" src="https://platform.slack-edge.com/img/add_to_slack.png" srcset="https://platform.slack-edge.com/img/add_to_slack.png 1x, https://platform.slack-edge.com/img/add_to_slack@2x.png 2x" /></a>
+
+Common phrases to try:
+
+> Always be building!
+
+> You pick lunch
+
+> I'm not merging until you fix your commits!
+
+> Per my last email...
+
+## Contributing
+
+Feel free to file an issue for any features you'd like to see, and of course...
+
+### PR's 👏🏾 ARE 👏🏾 WELCOME!👏🏾
diff --git a/dist/index.html b/dist/index.html
@@ -7,6 +7,6 @@
   <title>Clapback</title>
 </head>
 <body>
-  Test
+  Coming soon!
 </body>
 </html>
diff --git a/images/sassy.jpg b/images/sassy.jpg
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,6 @@ @@
       <title>Clapback</title>
     </head>
     <body>
-      Test
+      Coming soon!
     </body>
     </html>