updated readme documentation
This commit is contained in:
parent
ad0d0c3a55
commit
113990ac54
1 changed files with 16 additions and 2 deletions
18
README.md
18
README.md
|
|
@ -1,11 +1,25 @@
|
||||||
# sTodo
|
# sTodo
|
||||||
Stuce's simple todo is a web app that let's you self host a simple todolist.
|
Stuce's simple todo is a web app that let's you self host a simple todolist.
|
||||||
The goal is to provide a minimalistic and fast todo list that is self hostable.
|
The goal is to provide a minimalistic and fast todo list that is self hostable.
|
||||||
|
## Next goals
|
||||||
|
- Make multi user support
|
||||||
|
- [ ] Get user by trusted header
|
||||||
|
- [ ] Add option to enable single user (usefull for vpn single user easy setup)
|
||||||
|
- [ ] Add menu to add other users to the group
|
||||||
|
- [ ] make the code more readable by renaming/moving the handlers better
|
||||||
|
- [ ] write a minimal step by step guide to install with nix,
|
||||||
|
- [ ] add some css to make it look nicer
|
||||||
|
- [ ] add htmx to make more agreable without making js manadatory
|
||||||
## Version 1.0.0
|
## Version 1.0.0
|
||||||
Simple todo list for **single user only** at the moment.
|
Simple todo list for **single user only** at the moment.
|
||||||
|
Features :
|
||||||
|
- add and delete (and soon share) groups that contain a list of todolists
|
||||||
|
- add and delete todolists inside groups
|
||||||
|
- add todolist items or edit complete list via text for easy manipulation
|
||||||
|
- possibility to deploy easily via nix module with a flake
|
||||||
|
- that's it, the goal is to keep it minimal !!!
|
||||||
|
|
||||||
## Haskell Setup
|
## Haskell Setup (I sadly don't use nix develop at the moment)
|
||||||
|
|
||||||
1. If you haven't already, [install Stack](https://haskell-lang.org/get-started)
|
1. If you haven't already, [install Stack](https://haskell-lang.org/get-started)
|
||||||
* On POSIX systems, this is usually `curl -sSL https://get.haskellstack.org/ | sh`
|
* On POSIX systems, this is usually `curl -sSL https://get.haskellstack.org/ | sh`
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue