diff --git a/.gitignore b/.gitignore index ad46b30..25b6330 100644 --- 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 index 5a2560c..b8df269 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,44 @@ -# slack-clapback -GET 👏🏾SASSY👏🏾WITH👏🏾YOUR👏🏾SENTENCE👏🏾 +# SLACK CLAPBACK + +

+ ADD👏🏾SOME👏🏾SASS👏🏾TO👏🏾YOUR👏🏾SENTENCE!👏🏾 + +

+ +## 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: + +Add to Slack + +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!👏🏾 \ No newline at end of file diff --git a/dist/index.html b/dist/index.html index 15ed9ad..dd51c38 100644 --- a/dist/index.html +++ b/dist/index.html @@ -7,6 +7,6 @@ Clapback - Test + Coming soon! \ No newline at end of file diff --git a/images/sassy.jpg b/images/sassy.jpg new file mode 100644 index 0000000..c22edd4 Binary files /dev/null and b/images/sassy.jpg differ