add: README.md

1 files changed, 49 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bb71343
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+wcli - weather cli
+==================
+wcli is a samll program for fetching and printing weather information.
+
+
+Requirements
+------------
+To compile wcli and wcli-gen you will need the json-c header files.
+
+To fetch the data you will need wget.
+
+
+Installation
+------------
+Enter the following command to compile and install wcli:
+```sh
+make install
+```
+By default, everything is installed in ~/.local/bin. To change the
+install directory, edit config.mk.
+
+
+Running wcli
+------------
+Using wcli effectively involves two separate processes.
+1. Fetching the weather data
+2. Printing it in a sensible format
+
+The fetched data is stored locally, so there is no need to fetch the
+weather data right before printing. All the data is fetched from
+wttr.in. To fetch the data run:
+```sh
+wcli-query
+```
+
+Printing the weather information is done by running:
+```sh
+wcli [FORMAT]
+```
+You can find the format in the man page.
+
+
+Configuartion
+-------------
+The settings for compiling and installing wcli are in config.mk
+
+By default wcli will keep the weather data in ~/.local/share/wcli. To
+change the directory edit the config.h file and the wcli-query script.
+If you don't see the config.h file, try building wcli.