lockbot icon indicating copy to clipboard operation
lockbot copied to clipboard

Improve README.md

Open connorads opened this issue 5 years ago • 3 comments

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 feedback 40ms)
  • [x] Explain core of bot logic is encapsulated in lock-bot.ts without 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.ts and serverless.yaml etc.
  • [x] Forks and/or contributions are welcome

Deployment

Misc

  • [x] Add to Slack button
  • [x] Licence badge

connorads avatar May 30 '20 13:05 connorads

Readme inspiration? https://github.com/enzymejs/enzyme

image

connorads avatar Jun 12 '20 11:06 connorads

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

ccaAV avatar Jun 15 '20 13:06 ccaAV

Thanks for the feedback @ccaAV!

I've updated the README and the website

Let me know what you think 🙃

connorads avatar Jun 22 '20 23:06 connorads