Do some rudamentary README improvement
All checks were successful
continuous-integration/drone/pr Build is passing
continuous-integration/drone/push Build is passing

Signed-off-by: Sam Therapy <sam@samtherapy.net>
This commit is contained in:
Sam Therapy 2022-03-14 10:18:47 +01:00
parent b71ef3653e
commit 67a86124b0
Signed by: sam
GPG key ID: 4D8B07C18F31ACBD

View file

@ -2,10 +2,13 @@
[![Build Status](https://ci.git.froth.zone/api/badges/Sam/fediverse-imagebot/status.svg)](https://ci.git.froth.zone/Sam/fediverse-imagebot)
A bot that posts (currently only local) images to the Fediverse.
A bot that posts local and booru images to the Fediverse.
Compatible with Mastodon, Misskey and Pleroma!
## Boorus supported
The full list of boorus supported is found [here](https://github.com/AtoraSuunva/booru/blob/master/src/sites.json).
## Downloading pre-built binaries
Download prebuilt binaries from [here](https://git.froth.zone/Sam/fediverse-imagebot/releases/latest) (currently only supports x64), or build from source, instructions below.
@ -17,7 +20,8 @@ Download prebuilt binaries from [here](https://git.froth.zone/Sam/fediverse-imag
- Node 15 or greater is required.
2. Install `yarn`: \
`npm install --global yarn`
`corepack enable` \
Check https://yarnpkg.com/getting-started/install for more information.
- This may be need to ran with `sudo` depending on your installation.
@ -25,11 +29,15 @@ Download prebuilt binaries from [here](https://git.froth.zone/Sam/fediverse-imag
`git clone https://git.froth.zone/Sam/fediverse-imagebot.git`
4. Install dependencies: \
`yarn --production`
`yarn`
5. Build: \
`yarn build`
6. Edit the config file: \
`cp config.sample.jsonc config.jsonc`
- If you want to generate a key you can use https://git.froth.zone/Sam/js-feditoken
6. Run the bot: \
`yarn bot`
@ -41,7 +49,7 @@ You're done! The bot should post a local image to the fediverse instance of your
2. Put images in the `images` folder.
- By default the bot will look for SFW images at `images/sfw` and NSFW images at `images/nsfw`. This can be configured with the `-d` flag.
- By default the bot will look for SFW images at `images/sfw` and NSFW images at `images/nsfw`. This can be configured with the `directory` config setting.
## Automating the bot
@ -51,9 +59,9 @@ The bot can be automated to post images at set times using a cronjob. \
Example cron configuration:
```
0 * * * * cd /path/to/fediverse-imagebot && /usr/local/bin/yarn local -m "Message"
0 * * * * cd /path/to/fediverse-imagebot && /usr/local/bin/yarn bot -c ./config.sample.jsonc
```
This example will run the bot every hour on the hour with the post message `Message` using images from the default `images` directory.
This example will run the bot every hour on the hour with no message using images from the default `images` directory.
An example of this pleroma configuration can be found at https://froth.zone/rinbot.