From ab880bbbbb71a7c66f060dac1844463036646189 Mon Sep 17 00:00:00 2001
From: Dan Anglin <daangling@gmail.com>
Date: Mon, 23 Sep 2024 17:08:24 +0100
Subject: [PATCH] update documentation

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bec9723..337d135 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
 # pokecli
 
-A simple CLI application for exploring the Pokémon world.
+## 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