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

chore: update readme

Browse source
This commit is contained in:
Ayo Ayco 2024-04-28 11:08:30 +02:00
parent 2e8fd9b444
commit 4675c6a6fa
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -2,6 +2,14 @@
Show off your favorite public threads and offer hand-picked, fine-grained, topical subscriptions!
These are streams of thought you decide to float to your personal site for being a bit more-effort than other small posts, but still yet to be refined as a blog.
How it works:
1. a featured status will be fetched on the server along with qualified "descendants", which are replies of the same author in a single thread.
2. clean HTML with some styling will be sent to the viewer's browser
3. it is therefore zero-JS as of yet
4. self-hostable with the app configuration in `threads.py` file -- we are working on a docker way and easy configuration
See it [in action](https://ayco.io/threads).
## Project setup