sam/fediverse-imagebot
sam
/
fediverse-imagebot
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 4 Wiki Activity

add NPM instructions
continuous-integration/drone/push Build is passing Details 

Signed-off-by: Sam Therapy <sam@samtherapy.net>
This commit is contained in:
Sam Therapy 2022-12-29 15:15:36 +01:00
parent 927f556160
commit 3cd41e9ad8
Signed by: sam
GPG Key ID: 4D8B07C18F31ACBD
1 changed files with 20 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -18,16 +18,6 @@ The full list of boorus supported is found [here](https://github.com/AtoraSuunva
There are currently three ways to do this, a pre-built binary that bundles in node, from npm, or building from source. Both are listed below.
### Downloading pre-built binaries
Download prebuilt binaries from [here](https://git.froth.zone/sam/fediverse-imagebot/releases/latest). (currently supports x86_64 and arm64 on Linux
[glibc or musl], macOS and Windows)
1. Run the bot with the `-w` flag to have it generate a configuration file to the local directory.
2. Edit it for your use case.
- If you want to generate a key you can use <https://git.froth.zone/sam/js-feditoken>
3. Run the bot by launching the executable!
### From NPM
1. Set up using the [Gitea registry](https://git.froth.zone/sam/fediverse-imagebot/packages)
@ -36,12 +26,30 @@ Download prebuilt binaries from [here](https://git.froth.zone/sam/fediverse-imag
npm config set @froth:registry https://git.froth.zone/api/packages/sam/npm/
```
2. After setting up the registry, either install it permanently
2. After setting up the registry, either run it once
```sh
npx --package=@froth/feditoken feditoken
npx --package=@froth/fediverse-imagebot fediverse-imagebot
```
or install globally
```sh
npm i -g @froth/fediverse-imagebot
```
### Downloading pre-built binaries
#### NOTE: This is no longer supported since vercel/pkg is broken
Download prebuilt binaries from [here](https://git.froth.zone/sam/fediverse-imagebot/releases/latest). (currently supports x86_64 and arm64 on Linux
[glibc or musl], macOS and Windows)
1. Run the bot with the `-w` flag to have it generate a configuration file to the local directory.
2. Edit it for your use case.
- If you want to generate a key you can use <https://git.froth.zone/sam/js-feditoken>
3. Run the bot by launching the executable!
### Running from Source
1. You need to have `npm` and `nodejs` installed.