Add a README
continuous-integration/drone/push Build is passing Details

Signed-off-by: Sam Therapy <sam@samtherapy.net>
This commit is contained in:
Sam Therapy 2022-02-16 09:53:50 -06:00
parent 161bb0a73f
commit 1b90d8f203
Signed by: sam
GPG Key ID: 4D8B07C18F31ACBD
3 changed files with 20 additions and 6 deletions

View File

@ -52,9 +52,6 @@ steps:
base_url: https://git.froth.zone
files:
- dist/feditoken-*
checksum:
- md5
- sha1
when:
event:
- tag

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# JS-Feditoken
[![Build Status](https://ci.git.froth.zone/api/badges/Sam/js-feditoken/status.svg)](https://ci.git.froth.zone/Sam/js-feditoken)
Generating a token that can be used to botpost to the Fediverse.
Compatible with Mastodon, Misskey, and Pleroma.
## Usage
Download prebuilt binaries from [here](https://git.froth.zone/Sam/js-feditoken/releases/latest) (currently only supports x64), or build from source.
### Building from source
1. Clone the repository.
2. Make sure you have `yarn` and `nodejs>=15.0.0` installed.
3. Run `yarn` to install dependencies.
4. Run `yarn build` to build the binaries.
5. Run `yarn token` to run get the tokens.

View File

@ -23,11 +23,11 @@
"bin": "dist/token.js",
"scripts": {
"build": "yarn clean && tsc",
"package": "pkg dist/token.js -t node16-linux-x64,node16-macos-x64,node16-win-x64 -o dist/feditoken -C Gzip",
"clean": "rm -rf dist",
"token": "node ./dist/token.js",
"lint": "eslint --ext .ts src",
"test": "echo \"No tests yet!\" && exit 0"
"package": "pkg dist/token.js -t node16-linux-x64,node16-macos-x64,node16-win-x64 -o dist/feditoken-x64 -C Gzip",
"test": "echo \"No tests yet!\" && exit 0",
"token": "node ./dist/token.js"
},
"repository": "https://git.froth.zone/Sam/js-feditoken",
"author": "Sam Therapy <sam@samtherapy.net>",