From 92f2d344b23774fa370a5e46c2305604055707da Mon Sep 17 00:00:00 2001
From: gauvain-thomas <gauvain.thomas@ens-rennes.fr>
Date: Sun, 18 Feb 2024 16:26:53 +0100
Subject: [PATCH] README

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c6c6ff1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# pkmn
+
+## Description
+
+A simple program to display a Pokémon in the terminal. Based on cowsay.
+
+## Usage
+
+```bash
+pkmn <pokémon> [options]
+```
+
+## Options
+
+- `--help`: Display help message
+<!-- - `-l` or `--list`: List all available pokémon -->
+- `r` or `--random`: Display a random pokémon
+- `s` or `--shiny`: Display a shiny pokémon
+
+## Examples
+
+```bash
+pkmn pikachu
+```
+
+```bash
+pkmn pikachu -s
+```
+
+```bash
+pkmn -r
+```
+
+```bash
+pkmn -rs
+```
+
+## TODO
+- [ ] Add option to list available pokémon
+- [ ] Add option to open an fzf window to select a pokémon
+- [ ] Add argument to display a message
+
+
+## Dependencies
+- fzf
+- cowsay
\ No newline at end of file