From b28a1c97cbd4c0afb51da94407d180d4cee86a2c Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Thu, 6 Jul 2023 17:29:29 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20KeyDB,=20megalodon?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++---- packages/README.md | 1 + 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9701bc86e..4a58a2709 100644 --- a/README.md +++ b/README.md @@ -106,8 +106,8 @@ If you have access to a server that supports one of the sources below, I recomme - [ElasticSearch](https://www.elastic.co/elasticsearch/) - Caching server - 🐲 At least [DragonflyDB](https://www.dragonflydb.io/) v1.4.0 (recommended) + - 👻 At least [KeyDB](https://keydb.dev/) v6.3.3 - 🍱 Another [Redis](https://redis.io/) server, at least v6 - - 👻 [KeyDB](https://keydb.dev/) (untested) ### 🏗️ Build dependencies - 🦀 At least [Rust](https://www.rust-lang.org/) v1.68.0 @@ -166,9 +166,7 @@ In Calckey's directory, fill out the `db` section of `.config/default.yml` with ## 💰 Caching server -If you experience a lot of traffic, it's a good idea to set up another Redis-compatible caching server. If you don't set one one up, it'll fall back to the mandatory Redis server. - -For DragonflyDB, launch with the flag `--default_lua_flags='allow-undeclared-keys'`. +If you experience a lot of traffic, it's a good idea to set up another Redis-compatible caching server. If you don't set one one up, it'll fall back to the mandatory Redis server. DragonflyDB is the recommended option due to its unrivaled performance and ease of use. ## 🔎 Set up search diff --git a/packages/README.md b/packages/README.md index 7d7c03e0b..0ed7c6403 100644 --- a/packages/README.md +++ b/packages/README.md @@ -7,3 +7,4 @@ This directory contains all of the packages Calckey uses. - `client`: Web interface written in Vue3 and TypeScript - `sw`: Web [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) written in TypeScript - `calckey-js`: TypeScript SDK for both backend and client, also published on [NPM](https://www.npmjs.com/package/calckey-js) for public use +- `megalodon`: TypeScript library used for partial Mastodon API compatibility