Add README

This commit is contained in:
franjsco 2020-12-03 19:19:56 +01:00
parent 45eb241c6b
commit 72345267c6
1 changed files with 42 additions and 0 deletions

42
README.md Normal file
View File

@ -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
```