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

Document incorrect storage adapter mentioned in installation example (SQLite → Redis) #1292

Closed
Sho2010 opened this issue Jan 29, 2025 · 2 comments

Comments

@Sho2010
Copy link

Sho2010 commented Jan 29, 2025

First of all, thank you for maintaining this awesome project!

Description

I noticed a small inconsistency in the documentation. The installation section mentions SQLite as the storage adapter, but the example command actually installs @keyv/redis. Additionally, the rest of the documentation refers to Redis, not SQLite.

## 2. Installing Keyv and its Dependencies
To begin, install Keyv and a storage adapter of your choice. In this example, we'll use SQLite:
```bash
$ npm install cacheable @keyv/redis --save
```

@jaredwray
Copy link
Owner

@Sho2010 - thanks for the catch! Updated the code and should have it pushed live in a week or two.

@Sho2010
Copy link
Author

Sho2010 commented Feb 5, 2025

thx for fix ❤

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

No branches or pull requests

2 participants