Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README.md #24

Open
13 of 15 tasks
connorads opened this issue May 30, 2020 · 3 comments
Open
13 of 15 tasks

Improve README.md #24

connorads opened this issue May 30, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation feedback wanted Extra feedback is needed good first issue Good for newcomers help wanted Extra attention is needed

Comments

@connorads
Copy link
Owner

connorads commented May 30, 2020 •
edited
Loading

Usage

  • GIF to demonstrate usage
  • Explain channel segregation
  • What's it all for/about? Use cases? Why?
  • Link to website for demo
  • Test the app in a channel with yourself

Dev stuff

  • Tests run twice: 1) using in-memory (fast dev feedback 1ms) and 2) using local dynamodb (still fast feedback 40ms)
  • Explain core of bot logic is encapsulated in lock-bot.ts without reference to slack so could be ported to other chat platforms
  • Bot logic works against repository abstraction, easy to port to different database/storage
  • Can use other cloud cloud platform's serverless function offering, just need to adapt index.ts and serverless.yaml etc.
  • Forks and/or contributions are welcome

Deployment

Misc

  • Add to Slack button
  • Licence badge
@connorads connorads added the documentation Improvements or additions to documentation label May 30, 2020
@connorads
Copy link
Owner Author

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

image

@ccaAV
Copy link

ccaAV commented Jun 15, 2020

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

@connorads
Copy link
Owner Author

Thanks for the feedback @ccaAV!

I've updated the README and the website ✨

Let me know what you think 🙃

@connorads connorads added good first issue Good for newcomers help wanted Extra attention is needed feedback wanted Extra feedback is needed labels Jun 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation feedback wanted Extra feedback is needed good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@connorads @ccaAV