generated from templates/go-generic
38 lines
812 B
Markdown
38 lines
812 B
Markdown
# pokecli
|
|
|
|
## Overview
|
|
|
|
**pokecli** is a simple CLI application that uses the [PokéAPI](https://pokeapi.co/) for exploring the Pokémon world and capturing Pokémon.
|
|
|
|
### Repository mirrors
|
|
|
|
- **Code Flow:** https://codeflow.dananglin.me.uk/apollo/pokecli
|
|
- **GitHub:** https://github.com/dananglin/pokecli
|
|
|
|
## Requirements
|
|
|
|
- **Go:** A minimum version of Go 1.23.1 is required for building the pokecli. Please go [here](https://go.dev/dl/) to download the latest version.
|
|
|
|
## Build the application
|
|
|
|
Clone this repository to your local machine.
|
|
|
|
```
|
|
git clone https://github.com/dananglin/pokecli.git
|
|
```
|
|
|
|
Build the application.
|
|
|
|
- Build with go.
|
|
```
|
|
go build -o pokecli .
|
|
```
|
|
|
|
- Or build with [mage](https://magefile.org/) if you have it installed.
|
|
```
|
|
mage clean build
|
|
```
|
|
|
|
## Usage
|
|
|
|
TBC
|