Add doc/; Swap sections in README

This commit is contained in:
Jaidyn Ann 2023-11-19 22:55:20 -06:00
parent ac0108e44f
commit 99fdf1f676
2 changed files with 15 additions and 15 deletions

View File

@ -8,6 +8,20 @@ sfeed_mastodon takes output from the lovely feed-aggregator [sfeed](https://code
## Usage
```
$ FEDI_AUTH="yourAuthorizationTokenHere"
$ sfeed_update ~/.config/sfeedrc
$ cat ~/.config/sfeed/* | sfeed_mastodon https://yourServer.here
```
Its that simple. Its safe to run these commands several times in a row — feed entries that have
already been posted wont be reposted, if you use our example sfeedrc.
To automatically mirror an Atom/RSS feed, you can put these commands into a script and put it in your crontab.
## Installation ## Installation
First, make sure to install [sfeed](https://codemadness.org/sfeed-simple-feed-parser.html). First, make sure to install [sfeed](https://codemadness.org/sfeed-simple-feed-parser.html).
If Guix is your package manager: If Guix is your package manager:
@ -48,21 +62,7 @@ Whenever you use sfeed_mastodon, make sure that this token is stored in the envi
`$FEDI_AUTH`, or pass it with the `-a` parameter. `$FEDI_AUTH`, or pass it with the `-a` parameter.
### Formatting
## Usage
```
$ FEDI_AUTH="yourAuthorizationTokenHere"
$ sfeed_update ~/.config/sfeedrc
$ cat ~/.config/sfeed/* | sfeed_mastodon https://yourServer.here
```
Its that simple. Its safe to run these commands several times in a row — feed entries that have
already been posted wont be reposted, if you use our example sfeedrc.
To automatically mirror an Atom/RSS feed, you can put these commands into a script and put it in your crontab.
### Templates
You might want to know about the template parameter (`-t`) — this lets you tweak the output for You might want to know about the template parameter (`-t`) — this lets you tweak the output for
sfeed_mastodon as you wish. With this, you can add specific hash-tags to your posts, for example. sfeed_mastodon as you wish. With this, you can add specific hash-tags to your posts, for example.
Its argument should be HTML with some variables within {{double-cramps}} for post data. Its argument should be HTML with some variables within {{double-cramps}} for post data.