readme added

mvrck96 · Oct 11, 2023 · aa305ae · aa305ae
1 parent e83d6d8
commit aa305ae
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,12 @@
-# ipgeocheck
+# ipgeocheck
+
+Geolocation by IP made simple.
+
+## Instalation
+
+To use this utility you need:
+
+1. Clone this repo
+2. `cd` to folder
+3. Install required packages: `pip install -r requirements.txt`
+4. Execute `--help` option: `python3 ipgeocheck --help`