This repository has been archived on 2023-05-27. You can view files and clone it, but cannot push or open issues or pull requests.
js-feditoken/README.md
Sam Therapy 97e798d44b
All checks were successful
continuous-integration/drone/push Build is passing
add NPM instructions
Signed-off-by: Sam Therapy <sam@samtherapy.net>
2022-12-29 15:15:37 +01:00

1.2 KiB

JS-Feditoken

Build Status

Generating a token that can be used to botpost to the Fediverse.

Compatible with Mastodon, Misskey, and Pleroma.

Usage

Download prebuilt binaries from here (currently supports x86_64 and arm64 on Linux [glibc or musl], macOS and Windows), download from NPM, or build from source.

NPM

  1. Set up using the Gitea registry

    npm config set @froth:registry https://git.froth.zone/api/packages/sam/npm/
    
  2. After setting up the registry, either run it once

    npx --package=@froth/feditoken feditoken
    

    or install globally

    npm i -g @froth/feditoken
    

Running from Source

  1. You need to have npm and nodejs installed.
  • Node 16 or greater is required.
  1. Install pnpm:
    corepack enable
    Check https://pnpm.io/installation for more information.

  2. Clone the repository:
    git clone https://git.froth.zone/sam/js-feditoken.git

  3. Install dependencies:
    pnpm i

  4. Build:
    pnpm run build