diff --git a/README.rst b/README.rst index 9c78097..4fe45cd 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ fuel_price_tracker ================== -Add a short description here! +Tool for sorting gas price according to a given French departement number Description @@ -15,5 +15,16 @@ A longer description of your project goes here... Note ==== -This project has been set up using PyScaffold 3.3.1. For details and usage -information on PyScaffold see https://pyscaffold.org/. +TODO : + +- Enhance the output display +- Integrating ot to a a Telegram Bot to leverage (longitude,latitude) given data. + +How to Use (example) from .src/fuel_price_tracker : + + python3 parsing.py --dept 86 --gas E10 + + Will return you a list of sorted dict of all gas stations of the 86 (Vienne) for SP95-E10. + + +