initial commit

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b4beeb5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# countryfetch
+
+A cli tool for fetching information about countries. It uses https://restcountries.com/ API for backend.
+
+## dependencies
+
+[DENO](https://deno.land/)
+
+## usage
+
+```bash
+deno run --allow-all /path/to/program/main.ts <arguments>
+```
+
+available arguments:
+
+- `find <country-name>` Find country information by name.
+- `sync` - Synchronizes databes, stores it in localStorage. This is done automatically, but can be triggered manually.
+- `random` - Get random country information.