lockbot
lockbot copied to clipboard
Improve README.md
Usage
- [ ] GIF to demonstrate usage
- [x] Explain channel segregation
- [x] What's it all for/about? Use cases? Why?
- [x] Link to website for demo
- [ ] Test the app in a channel with yourself
Dev stuff
- [x] Tests run twice: 1) using in-memory (fast dev feedback
1ms) and 2) using local dynamodb (still fast feedback40ms) - [x] Explain core of bot logic is encapsulated in
lock-bot.tswithout reference to slack so could be ported to other chat platforms - [x] Bot logic works against repository abstraction, easy to port to different database/storage
- [x] Can use other cloud cloud platform's serverless function offering, just need to adapt
index.tsandserverless.yamletc. - [x] Forks and/or contributions are welcome
Deployment
- [x] Tokens and environment variables
- [x] state secret 256-bit key (HS256 JWT)
- [x] Info about slack bot account
Misc
- [x] Add to Slack button
- [x] Licence badge
Readme inspiration? https://github.com/enzymejs/enzyme

more than gifs, a little text on what it is aiming at, and what it is NOT aiming to be used for would be great. The gifs would be more for "how users use it", the text, more for the technical perspective. Maybe