Update documentation to mention about the binary files
This commit is contained in:
parent
6232c8db7f
commit
cbe8ff6a79
2 changed files with 18 additions and 1 deletions
13
docs/cli.md
13
docs/cli.md
|
@ -2,6 +2,19 @@
|
|||
|
||||
Since Version 2.2, Random Bunny contains a command line interface (CLI).
|
||||
|
||||
## Downloads
|
||||
|
||||
The project can be downloaded as a binary for your system via the [GitHub Releases](https://github.com/Vylpes/random-bunny/releases) or [Gitea Releases](https://gitea.vylpes.xyz/RabbitLabs/random-bunny/releases) page.
|
||||
|
||||
We currently support:
|
||||
- Linux (x64)
|
||||
- Windows (x64)
|
||||
- macOS (x64, Arm64\*)
|
||||
|
||||
The git repository can also be cloned and ran via `yarn build` and `yarn start`.
|
||||
|
||||
> **NOTE:** We are aware of a bug in the macOS Arm64 builds failing to execute. For now you're still able to use the x64 builds under Rosetta fine. This will hopefully be fixed in a future release.
|
||||
|
||||
## Default Output
|
||||
|
||||
By default, the command will fetch a random image from `r/rabbits` and return it in a human-readable output.
|
||||
|
|
|
@ -14,6 +14,10 @@ or if you're using yarn
|
|||
yarn add random-bunny
|
||||
```
|
||||
|
||||
### Binary
|
||||
|
||||
The project can be downloaded as a binary for your system via the [GitHub Releases](https://github.com/Vylpes/random-bunny/releases) or [Gitea Releases](https://gitea.vylpes.xyz/RabbitLabs/random-bunny/releases) page.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
|
@ -48,7 +52,7 @@ The json string which gets returned consists of:
|
|||
|
||||
Random bunny can also be used as a CLI. This is accessible via the executable (see git releases) or via `src/cli.ts`
|
||||
|
||||
For more details, see the documentation.
|
||||
For more details, see the [documentation](https://docs.vylpes.xyz/books/random-bunny).
|
||||
|
||||
## Notes
|
||||
|
||||
|
|
Loading…
Reference in a new issue