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

Getting Started Guide 🎉 #530

Merged
merged 6 commits into from
Oct 28, 2022
Merged

Getting Started Guide 🎉 #530

merged 6 commits into from
Oct 28, 2022

Conversation

cprendergast19
Copy link
Contributor

@cprendergast19 cprendergast19 commented Oct 26, 2022

Created a Getting Started Guide

Please check if the PR fulfills these requirements

  • Followed the Contributing guidelines.
  • Tests for the changes have been added (for bug fixes/features) with 100% code coverage.
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
for issue / feature #401

Created a Getting Started Guide
@codecov
Copy link

codecov bot commented Oct 27, 2022

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (8519e80) compared to base (7c17b52).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #530   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          341       341           
=========================================
  Hits           341       341           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@jaredwray jaredwray changed the title Update index.md Getting Started Guide 🎉 Oct 27, 2022
docs/getting-started/index.md Show resolved Hide resolved
docs/getting-started/index.md Show resolved Hide resolved
docs/getting-started/index.md Show resolved Hide resolved
docs/getting-started/index.md Outdated Show resolved Hide resolved
@jaredwray
Copy link
Owner

@cprendergast19 - this is really great progress so far. I think the next step after namespaces is to now take this code and add in compression using compress-gzip as an example. https://github.com/jaredwray/keyv/tree/main/packages/compress-gzip

After that it would be really cool to show that with this code example we an do tiered where we now do in memory and use the storage adapter as the backend.

Updates made basted on feedback from Jared.
Added Sections 6 and 7 Compression and Caching
Added example to #3.
Updated example
@cprendergast19
Copy link
Contributor Author

@jaredwray I've made all the updates based on the feedback so far.

Updated the title of #7
@jaredwray jaredwray merged commit e9ee621 into jaredwray:main Oct 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants