[SKIP CI] README

Signed-off-by: Sam Therapy <sam@samtherapy.net>
This commit is contained in:
Sam Therapy 2022-03-16 21:40:58 +01:00
parent fef9ebb4a6
commit 379c74fc1c
Signed by: sam
GPG key ID: 4D8B07C18F31ACBD
3 changed files with 1 additions and 20 deletions

View file

@ -1,16 +0,0 @@
# Migrating
Migrating to any version in the same major version (e.g. `1.0.0` -> `1.1.0`) is a safe operation, nothing additional is required.
Migrating to a major version (e.g. `1.1.0` -> `2.0.0`) can be done by following the instructions below.
## Migrating to 2.0.0 from 1.x.x
Version 2.0.0 changes the configuration file and flags considerably, to make it easier to use and allow for more flexibility. An example configuration migration can be found below.
### Migrating the configuration file
1. Make a backup of your old `config.json`
2. Migrate your configuration file
* If running from source, edit the `config.sample.jsonc` file to your liking and save it as `config.jsonc`, the configuration location flag `-c` still works as before.
* If running from binary, run the file with `-w` to write a new configuration file `config.jsonc` to the current directory.
3. Migrate the runtime flags
- `-m` is now `message` in the config.
- `-d` is now `directory` in the config.

View file

@ -40,8 +40,6 @@ Download prebuilt binaries from [here](https://git.froth.zone/Sam/fediverse-imag
`corepack enable` \
Check https://yarnpkg.com/getting-started/install for more information.
- This may be need to ran with `sudo` depending on your installation.
3. Clone the repository: \
`git clone https://git.froth.zone/Sam/fediverse-imagebot.git`
@ -53,7 +51,6 @@ Download prebuilt binaries from [here](https://git.froth.zone/Sam/fediverse-imag
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
7. Run the bot: \

View file

@ -16,7 +16,7 @@
"pkg": {
"scripts": "dist/**/*.js",
"targets": [
"node16-linux-arm64",
"node16-linux",
"node16-macos",
"node16-win"
]