From 244a1e866784db8f22b9b5ed1f00b4ae63c5b10a Mon Sep 17 00:00:00 2001 From: Jared Wray Date: Wed, 14 Sep 2022 09:21:53 -0400 Subject: [PATCH] updating readme with direct link to keyv package --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e39190c1..050bfad6d 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,13 @@ Keyv and its storage adapters are in this mono repo and there are details below * [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Our code of conduct * [CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute to this project -* [SECURITY.md](SECURITY.md) - Security guidelines and supported versions +* [SECURITY.md](SECURITY.md) - Security guidelines and supported versions + +## Getting Started + +Keyv is a simple key-value storage system that supports multiple backends. It's designed to be a simple and consistent way to work with key-value stores. + +To learn how to use Keyv, check out the [keyv](https://github.com/jaredwray/keyv/blob/main/packages/keyv/README.md) README. To learn how to use a specific storage adapter, check out the README for that adapter under [Storage Adapters](#storage-adapters). ## Open a Pull Request