From 57a173e1b9528f71a09b365882c9e5c7fe76077b Mon Sep 17 00:00:00 2001 From: Kilian Decaderincourt Date: Wed, 8 Sep 2021 17:54:32 +0200 Subject: [PATCH] docs: add small presentation --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b354d19..75b1348 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # excalidraw-storage-backend +This is a reimplementation of [excalidraw-json](https://github.com/excalidraw/excalidraw-json) suitable for self hosting you own instance of Excalidraw. + +It can be used with [kiliandeca/excalidraw-fork](https://gitlab.com/kiliandeca/excalidraw-fork) + +[DockerHub kiliandeca/excalidraw-storage-backend](https://hub.docker.com/r/kiliandeca/excalidraw-storage-backend) + ## Environement Variables | Name | Description | Default value | | --------------- | ------------------------------------------------------------ | ---------------- | | `PORT` | Server listening port | 8080 | | `GLOBAL_PREFIX` | API global prefix for every routes | `/api/v2` | -| `STORAGE_URI` | [keyv](https://github.com/lukechilds/keyv) connection string | `""` (in memory) | +| `STORAGE_URI` | [Keyv](https://github.com/lukechilds/keyv) connection string | `""` (in memory) | -Availabe storage adapter: redis, mongo, postgres and mysql +Availabe Keyv storage adapter: redis, mongo, postgres and mysql