jadedctrl/ sfeed_mastodon
1
0
Disbranĉigi 0
Fontkodo Issues 1 Tirpetoj Activity

Move doc/ to docs/

This commit is contained in:
Jaidyn Ann 2023-11-19 23:12:09 -06:00
parent 88b0115007
commit cea28c643c
4 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -54,10 +54,10 @@ You’ve done it!
### sfeed ### sfeed
If you want to regularly update an RSS/Atom feed and post only new entries, we need to do some If you want to regularly update an RSS/Atom feed and post only new entries, we need to do some
configuration for `sfeed_update`. For this, we’ve gotta create a config file and feed directory. configuration for `sfeed_update`. For this, we’ve gotta create a config file and feed directory.
You should use the `sfeedrc.example file` in this repo as a base for your own config file. You should use the `docs/sfeedrc.example file` in this repo as a base for your own config file.
``` ```
$ mkdir ~/.config/sfeed/ $ mkdir ~/.config/sfeed/
$ cp sfeedrc.example ~/.config/sfeedrc $ cp docs/sfeedrc.example ~/.config/sfeedrc
``` ```
You need to edit the example sfeedrc to add in your own Atom/RSS feeds, or to change the feed path. You need to edit the example sfeedrc to add in your own Atom/RSS feeds, or to change the feed path.
@ -85,7 +85,7 @@ Whenever you use sfeed_mastodon, make sure that this token is stored in the envi
### mirror_feed ### mirror_feed
To automatically mirror an Atom/RSS feed, you can make a script that runs `sfeed_update` & To automatically mirror an Atom/RSS feed, you can make a script that runs `sfeed_update` &
`sfeed_mastodon`, and then put it in your crontab. `doc/mirror_feed.sh` is a script which does exactly this. `sfeed_mastodon`, and then put it in your crontab. `docs/mirror_feed.sh` is a script which does exactly this.
To use `mirror_feed.sh` with the `~/.config/sfeedrc` from our [prior configuration](#sfeed): To use `mirror_feed.sh` with the `~/.config/sfeedrc` from our [prior configuration](#sfeed):
``` ```
@ -97,7 +97,7 @@ exports two variables: `$FEDI_SERVER` and `$FEDI_AUTH`. It will be sourced by `m
though you can optionally set these variables in the environment instead. though you can optionally set these variables in the environment instead.
Barring that, `mirror_feed.sh` expects a directory containing `sfeedrc` and a subdirectory `sfeed/` Barring that, `mirror_feed.sh` expects a directory containing `sfeedrc` and a subdirectory `sfeed/`
for posts — just like the example configuration in `~/.config` [discussed earlier](#sfeed). for posts — just like the configuration in `~/.config` [discussed earlier](#sfeed).
### Formatting ### Formatting

0
doc/mirror_feed.sh → docs/mirror_feed.sh
View File

0
doc/sfeedenv.example → docs/sfeedenv.example
View File

0
doc/sfeedrc.example → docs/sfeedrc.example
View File