Update documentation
This commit is contained in:
34
README.md
34
README.md
@ -1,7 +1,37 @@
|
|||||||
# WeatherToFreemobile
|
# WeatherToFreemobile
|
||||||
|
|
||||||
A simple script that sends [OpenWeatherMap](https://openweathermap.org/) forecasts to a [FreeMobile](http://mobile.free.fr/) phone.
|
## English
|
||||||
|
A simple script that sends [OpenWeatherMap](https://openweathermap.org/) forecasts as a text message to a [FreeMobile](http://mobile.free.fr/) phone.
|
||||||
|
|
||||||
To run the script you need to fill in `config.sample.json` and to rename it to `config.json`.
|
To run the script you need to fill in `config.sample.json` and to rename it to `config.json`.
|
||||||
|
|
||||||
See `Pipfile` for the script's requirements.
|
See `Pipfile` for the script's requirements.
|
||||||
|
|
||||||
|
Sample output:
|
||||||
|
```
|
||||||
|
Saturday 19: light rain (min 13ºC, max 15ºC, rain:1.44mm)
|
||||||
|
- 09h : 0.3mm
|
||||||
|
- 12h : 0.2mm
|
||||||
|
- 15h : 0.2mm
|
||||||
|
- 18h : 0.1mm
|
||||||
|
- 21h : 0.2mm
|
||||||
|
Sunday 20: moderate rain (min 12ºC, max 12ºC, rain:11.94mm)
|
||||||
|
```
|
||||||
|
|
||||||
|
## French
|
||||||
|
Un simple script pour envoyer les prévisions météo [OpenWeatherMap](https://openweathermap.org/) par SMS sur un téléphone [FreeMobile](http://mobile.free.fr/).
|
||||||
|
|
||||||
|
Pour lancer le script, vous avez besoin d'ajuster les éléments du fichier `config.sample.json` et le renommer en `config.json`.
|
||||||
|
|
||||||
|
Vous devrez installer les librairies décrites dans `Pipfile`.
|
||||||
|
|
||||||
|
Exemple de SMS:
|
||||||
|
```
|
||||||
|
Samedi 19: légère pluie (min 13ºC, max 15ºC, rain:1.44mm)
|
||||||
|
- 09h : 0.3mm
|
||||||
|
- 12h : 0.2mm
|
||||||
|
- 15h : 0.2mm
|
||||||
|
- 18h : 0.1mm
|
||||||
|
- 21h : 0.2mm
|
||||||
|
Dimanche 20: pluie modérée (min 12ºC, max 12ºC, rain:11.94mm)
|
||||||
|
```
|
||||||
|
@ -126,3 +126,4 @@ if __name__ == "__main__":
|
|||||||
)
|
)
|
||||||
wtf = WeatherToFreemobile(config_file)
|
wtf = WeatherToFreemobile(config_file)
|
||||||
wtf.send_sms_to_freemobile(wtf.get_weather())
|
wtf.send_sms_to_freemobile(wtf.get_weather())
|
||||||
|
print(wtf.get_weather())
|
||||||
|
Reference in New Issue
Block a user