From d58b4816b522475cba6c5b7f748451ff8db0fa19 Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Tue, 4 Jun 2024 17:33:30 +0200 Subject: [PATCH] chore: update readme to include config.json stuff --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index befa7a9..1f9258b 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ How it works: 2. clean HTML with some styling will be sent to the viewer's browser 3. bit of client-side JS for progressive enhancement: 1. `` by GitHub: https://github.com/github/relative-time-element -4. self-hostable with the app configuration in `threads.py` file -- we are working on a docker way and easy configuration +4. self-hostable with the app configuration in `config.json` file -- we are working on a docker way and easy configuration See it [in action](https://ayco.io/threads). @@ -45,6 +45,9 @@ See it [in action](https://ayco.io/threads). # install dependencies (.venv)$ python -m pip install -r requirements.txt + # create configuration from example config file + (.venv)$ cp ./example_config.json ./config.json + # rejoice! ```