Skip to content

Commit

Permalink
πŸ“š add acceptable use policy to readme
Browse files Browse the repository at this point in the history
add acceptable use policy to readme

πŸ“š Documentation
  • Loading branch information
TimMikeladze committed Jan 4, 2023
1 parent b4711ab commit f2644a5
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,7 @@ This is a dirty implementation of optimistic locking. It is not a perfect soluti
1. This is **not** a replacement for a **production database!** Do not store data that you cannot afford to lose or that needs to remain consistent. If it's important, use the proper database solution for your problem.
1. This is not intended for **high write** scenarios. You will be rate limited by the GitHub API. This is package is intended for **low write**, **single session** scenarios.
1. The maximum size that a value can be is approximately 10mb. However, I suspect a request that large would simply be rejected by the API. It's not a scenario I'm building for as sophisticated storage is beyond the scope of this library. Once again this is not a real database, it should not be used for storing large documents.

## βš–οΈβ€ Acceptable use policy

When using this library you **must comply** with Github's [acceptable use policy](https://docs.github.com/en/github/site-policy/github-acceptable-use-policies). Do not use this library to store data that violates Github's guidelines, violates laws, is malicious, unethical, or harmful to others.

0 comments on commit f2644a5

Please sign in to comment.