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.

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

Documentation: How to use our Mono Repo #324

Closed
jaredwray opened this issue May 10, 2022 · 0 comments
Closed

Documentation: How to use our Mono Repo #324

jaredwray opened this issue May 10, 2022 · 0 comments

Comments

@jaredwray
Copy link
Owner

Currently the main documentation on this repository is the same for the core Keyv package. We want to change that by having the following in the README.md root file of this github repository:

  • Still show the logo
  • Show the statistics of the Keyv downloads and other badges
  • Discuss how to use this mono repo for:
  • Post a Question
  • Post an Issue
  • How to do a Pull Request
  • How to request a storage adapter gets added
  • Show links to each of the packages and how to access their documentation
  • Would also like to list out our Security Program
  • List out our current contributors by referencing our new contributor doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant