commit 1bf0200d33d84187b22efcd9aafea09075452e8d
parent 0340516f3e5d5556b9d988524a44a7ff8a6a9fb4
Author: Frederic Cambus <fcambus@users.sourceforge.net>
Date: Wed, 20 Nov 2013 18:07:47 +0100
Documentation update
Diffstat:
| M | README.md | | | 39 | ++++++++++++++++++++++++++++++++++----- |
1 file changed, 34 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -7,6 +7,8 @@ terminal, with support for ANSI colors and Unicode symbols.
Weather data comes from the `OpenWeatherMap` free weather API.
+
+
## Requirements
AnsiWeather requires the following dependencies :
@@ -14,12 +16,24 @@ AnsiWeather requires the following dependencies :
- A command to fetch HTTP data such as [cURL](http://curl.haxx.se) or [wget](https://www.gnu.org/software/wget/)
- jq (lightweight and flexible command-line JSON processor) : http://stedolan.github.io/jq/
+
+
## Usage
After cloning the repository, simply invoke the script by typing :
./ansiweather
+
+
+## Command Line Options
+
+Any configuration options may also be passed in as command line options.
+
+ ./ansiweather -l Moscow -u metric -s true -f 5
+
+
+
## Configuration
The following configuration options are available and should be set according
@@ -32,7 +46,6 @@ Example : `~/.ansiweatherrc`
location:Moscow,RU
fetch_cmd:ftp -V -o -
units:metric
-
### Location
@@ -40,6 +53,22 @@ Example : `Moscow,RU`
location:Moscow,RU
+### Fetch Command
+
+Various tools can be used to fetch data : `curl`, `wget`, `ftp`.
+
+Example : `curl -s`
+
+ fetch_cmd:curl -s
+
+Example : `wget -qO-`
+
+ fetch_cmd:wget -qO-
+
+Example : `ftp -V -o -`
+
+ fetch_cmd:ftp -V -o -
+
### System of Units
Both `metric` and `imperial` systems are supported.
@@ -58,17 +87,15 @@ Show upcoming forecast for the next `N` days (for 0 <= N <= 7). `0` will show st
forecast:5
-## Command Line Options
-Any configuration options may also be passed in as command line options.
-
- ./ansiweather -l Moscow -u metric -s true -f 5
## License
AnsiWeather is released under the BSD 3-Clause license. See `LICENSE` file
for details.
+
+
## Author
AnsiWeather is developed by Frederic Cambus
@@ -76,6 +103,8 @@ AnsiWeather is developed by Frederic Cambus
- Site : http://www.cambus.net
- Twitter: http://twitter.com/fcambus
+
+
## Resources
GitHub : https://github.com/fcambus/ansiweather
