Skip to content

Commit

Permalink
Fix broken links in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
serpro69 committed Oct 23, 2023
1 parent 8aadc4f commit 2a41e3a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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).
11 changes: 9 additions & 2 deletions cli-bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 2a41e3a

Please sign in to comment.