From 72345267c6b8728b9cba89529ff7681ffa013d80 Mon Sep 17 00:00:00 2001
From: franjsco <33671357+franjsco@users.noreply.github.com>
Date: Thu, 3 Dec 2020 19:19:56 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e9f7f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# iliadly
+>  Consulta i contatori della tua offerta iliad direttamente dal terminale..
+
+Per utilizzarlo è necessario essere connessi con rete iliad.
+
+
+
+<a href="https://asciinema.org/a/pvb8xqDtOczwuZjahN08wosWY" target="_blank"><img src="https://asciinema.org/a/pvb8xqDtOczwuZjahN08wosWY.svg"/></a>
+
+
+## Installazione
+
+1. Clonare il repository:
+    ```sh
+    git clone https://github.com/franjsco/iliadly ~/.iliadly
+
+    cd ~/.iliadly
+    ```
+
+2. Installare le dipendenze
+    ```sh
+    pip install -r requirements.txt
+    ```
+
+3. Concedere i permessi di esecuzione allo script
+    ```sh
+    chmod +x iliadly.py
+    ```
+
+4. Creare collegamento simbolico in /usr/local/bin:
+    ```sh
+    cd /usr/local/bin
+    sudo ln -s ~/.iliadly/iliadly.py iliadly
+    ```
+
+
+## Utilizzo
+
+Per mostrare i contatori, aprire il terminale e lanciare il comando:
+```sh
+iliadly
+```