dennis/freed
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: updates readme with desired subcommands

Browse source
This commit is contained in:
Dennis Schoepf 2025-08-24 22:35:55 +02:00
parent 37af5fb345
commit 3d3daf737f
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -14,24 +14,32 @@ go install ...
### Add a RSS feed or youtube channel
Currently RSS feeds, Atom feeds and Youtube channel links are supported.
```sh
freed add
freed add "https://feed.url"
```
### List all feeds
Lists all currently stored feed with their metadata.
```sh
freed ls
```
### Show a feed entry for the day
Shows/opens an article from one of your feeds and marks it as read.
```sh
freed today
```
### Sync the added feeds
Manually syncs all feeds in the database. An automatic sync is performed on running any command if the last sync was more than 24 hours ago.
```sh
freed sync
```