update readme

2 files changed, 55 insertions, 4 deletions

diff --git a/README.md b/README.md
index 462c012..6732440 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,45 @@
 
 A cli tool for fetching information about countries. It uses https://restcountries.com/ API for backend.
 
-## dependencies
+![](./images/countryfetch.png)
+
+## Dependencies
 
 [DENO](https://deno.land/)
 
-## usage
+## Installation
+
+clone this repository:
+
+```bash
+git clone https://github.com/CondensedMilk7/countryfetch.git
+```
+
+navigate to the cloned repo folder and run install:
+
+```bash
+./install.sh
+```
+
+The app should now be installed.
+
+alternatively, you can compile it yourself and store it in your local bin directory (might be safer):
+
+```bash
+deno compile --allow-all main.ts
+cp ./countryfetch  ~/.local/bin
+```
+
+If after this your shell cannot find countryfetch, this means you haven't added your local bin to PATH. Either add it to PATH, or make an alias in your .bashrc or .zshrc:
 
 ```bash
-deno run --allow-all /path/to/program/main.ts <arguments>
+alias countryfetch="~/.local/bin/countryfetch"
+```
+
+## Usage
+
+```bash
+countryfetch <arguments>
 ```
 
 available arguments:
@@ -18,6 +49,26 @@ available arguments:
 - `sync` - Synchronizes databes, stores it in localStorage. This is done automatically, but can be triggered manually.
 - `random` - Get random country information.
 
-## Issues
+example:
+
+```
+$ countryfetch find germany
+
+# output:
+
+Country:	🇩🇪 Germany
+Languages:	German
+Capital:	Berlin
+Region:		Europe
+Population:	83,240,525
+Currencies:	Euro [€](EUR)
+
+```
+
+## Known issues
 
 - App will not match names that include "-", which is replaced by whitespace by program.
+
+## Contribution
+
+I will add new features when I have time, but you don't have to wait - add them yourself! Submit pull requests, or fork it and make it your own alltogether.
diff --git a/images/countryfetch.png b/images/countryfetch.png
new file mode 100644
index 0000000..cdcac7d
--- /dev/null
+++ b/images/countryfetch.png