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

write best-practices guide for safe, efficient, and effective usage #5

Open
clockelliptic opened this issue Jan 6, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@clockelliptic
Copy link
Owner

To Do: write best-practices guide for safe, efficient, and effective usage

Why:

  • so that it's clear how to make safe, efficient, and effective use of device storage
  • as that usage results in the most performant and effective outcomes
  • because this this library is flexible and convenient enough that it can be accidentally misused

Acceptance Criteria:

  • adds README documentation with best practices and scenarios
  • includes guidance on how to segment cache keys so that automatic pruning is effective on a per-app-page basis
  • includes guidance on when not to use this library
  • includes guidance on safe or effective alternatives for cases when this library is not a good fit
  • includes clear guidance on when to use this in lieu of service workers or a PWA
  • includes clear guidance on the vulnerabilities of IndexedDB caching compared to browser cache API
@clockelliptic clockelliptic added the documentation Improvements or additions to documentation label Jan 6, 2024
@clockelliptic clockelliptic changed the title todo: write best-practices guide for safe, efficient, and effective usage write best-practices guide for safe, efficient, and effective usage Jan 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant