Add readme
This commit is contained in:
parent
379df61598
commit
23b263a50b
1 changed files with 16 additions and 0 deletions
16
README.md
Normal file
16
README.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
## Usage
|
||||
|
||||
Use the `justfile` to run commands:
|
||||
|
||||
```bash
|
||||
just init # Will init the database, and build the app image
|
||||
just run # Will run the lwn-sub-snoozer to update the database and the RSS file
|
||||
```
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Nix service with timer
|
||||
- [ ] Better path managment, with env variable in Dockerfile
|
||||
- [ ] Clean repo
|
||||
- [ ] Add volume to the db to store it if it crashes
|
||||
- [ ] Add tests
|
||||
Loading…
Add table
Add a link
Reference in a new issue