From 8d7624e26337aec6820eec43042b8018c89c8901 Mon Sep 17 00:00:00 2001 From: Ethan Lane Date: Fri, 19 Apr 2024 18:30:12 +0100 Subject: [PATCH] Update documentation to mention about the binary files (#167) # Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - Add to the CLI documentation the mention about the binary releases - Mentioned about the fact you can't use macOS arm64 builds yet due to a bug to be fixed later on #152 ## Type of change Please delete options that are not relevant. - [x] New feature (non-breaking change which adds functionality) # How Has This Been Tested? Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration. # Checklist - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that provde my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/167 Reviewed-by: VylpesTester Co-authored-by: Ethan Lane Co-committed-by: Ethan Lane --- docs/cli.md | 13 +++++++++++++ readme.md | 6 +++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index 893fcd5..dbe1f20 100644 --- a/docs/cli.md +++ b/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. diff --git a/readme.md b/readme.md index 33d47ad..aa60089 100644 --- a/readme.md +++ b/readme.md @@ -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