aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..3e3a56a
--- /dev/null
+++ b/README.org
@@ -0,0 +1,23 @@
+* weather
+
+A simple server serving 7 day weather forecast of Victoria, Australia,
+using xmls from BoM.
+
+** Install
+#+begin_src sh
+cabal install
+#+end_src
+
+** Run
+#+begin_src sh
+~/.cabal/bin/weather
+#+end_src
+
+Then open a browser and navigate to <http://localhost:3000> to learn
+about the Melbourne weather for the next 7 days.
+
+For weather that is not in Melbourne, add /city/<cityName>, e.g.
+<http://localhost:3000/city/Bendigo>.
+
+Also serving JSON: <http://localhost:3000> and
+ <http://localhost:3000/json/city/Bendigo>.