ayo/threads
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme to include config.json stuff

Browse source
This commit is contained in:
Ayo Ayco 2024-06-04 17:33:30 +02:00
parent 5b75716725
commit d58b4816b5
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -9,7 +9,7 @@ How it works:
2. clean HTML with some styling will be sent to the viewer's browser 2. clean HTML with some styling will be sent to the viewer's browser
3. bit of client-side JS for progressive enhancement: 3. bit of client-side JS for progressive enhancement:
1. `<relative-time>` by GitHub: https://github.com/github/relative-time-element 1. `<relative-time>` 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). See it [in action](https://ayco.io/threads).
@ -45,6 +45,9 @@ See it [in action](https://ayco.io/threads).
# install dependencies # install dependencies
(.venv)$ python -m pip install -r requirements.txt (.venv)$ python -m pip install -r requirements.txt
# create configuration from example config file
(.venv)$ cp ./example_config.json ./config.json
# rejoice! # rejoice!
``` ```