From 2a41e3ade343a9a32bd15800ba8944830a958574 Mon Sep 17 00:00:00 2001 From: Sergio Pro <22973227+serpro69@users.noreply.github.com> Date: Mon, 23 Oct 2023 17:48:31 +0200 Subject: [PATCH] Fix broken links in readme --- README.md | 4 ++-- cli-bot/README.md | 11 +++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cee0e9610..d59128f5c 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ [![Issues](https://img.shields.io/github/issues/serpro69/kotlin-faker.svg?logo=GitHub&style=for-the-badge&color=lightblue)](https://github.com/serpro69/kotlin-faker/issues) ![GitHub Top Lang](https://img.shields.io/github/languages/top/serpro69/kotlin-faker.svg?logo=Kotlin&logoColor=white&color=A97BFF&style=for-the-badge) [![Awesome Kotlin](https://img.shields.io/badge/awesome-kotlin-orange?logo=Awesome-Lists&style=for-the-badge)](https://kotlin.link/resources?q=kotlin-faker) -[![Licence](https://img.shields.io/github/license/serpro69/kotlin-faker.svg?style=for-the-badge)](LICENCE.md) +[![Licence](https://img.shields.io/github/license/serpro69/kotlin-faker.svg?style=for-the-badge)](LICENSE.adoc) ## About @@ -142,4 +142,4 @@ Many thanks to these awesome tools that help us in creating open-source software ## Licence -This code is free to use under the terms of the MIT licence. See [LICENCE](LICENCE.adoc). +This code is free to use under the terms of the MIT licence. See [LICENSE](LICENSE.adoc). diff --git a/cli-bot/README.md b/cli-bot/README.md index 776a90da4..addd0b534 100644 --- a/cli-bot/README.md +++ b/cli-bot/README.md @@ -20,18 +20,25 @@ Quickly find required kotlin-faker functionality from your terminal ## Installation -The native images are available on [releases](https://github.com/serpro69/kotlin-faker/releases) page. +Zero-dependencies native images are available on [releases](https://github.com/serpro69/kotlin-faker/releases) page. Download the image to a desired location and make it executable or use below script (Depends on [jq](https://stedolan.github.io/jq/)) -``` +```bash cd ~ wget $(curl -s https://api.github.com/repos/serpro69/kotlin-faker/releases/latest | jq -r '.assets[].browser_download_url') -O faker-bot chmod a+x ~/faker-bot ``` +If you prefer a .jar instead of a native image, these are also available for each release. Just download the jar and run it with `java -jar`: + +```bash +java -jar ./faker-bot.jar --help +``` + ## Usage Usage details are also available with the `--help` option: + `./faker-bot --help` `./faker-bot list --help` `./faker-bot lookup --help`