summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 1ae8ffb..fe5c7c7 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-# Blaweather
+Blaweather
+==========
This is a ruby script for getting weather forecasts.
It will return the current weather, brief forecast for the day and week, and any predictions of rain for the next hour.
@@ -8,7 +9,8 @@ It uses Forecast.io as the source of weather data.
It uses Google Maps API to convert locations into lat/long co-ordinates which are needed for the forecast.
Any city, postal code, street address, place of interest, etc, should work.
-## Installation:
+Installation:
+----------------
Run the following to install the required gems -
@@ -16,7 +18,8 @@ Run the following to install the required gems -
Alternatively, install the 'json' and 'rest-client' Ruby Gems via your package manager.
-## Usage:
+Usage:
+------
`ruby blaweather.rb [location]`
@@ -26,7 +29,8 @@ e.g:
`ruby blaweather.rb W1A 1AA`
`ruby blaweather.r tower bridge`
-## To do:
+To do:
+------
1. Specify detailed forecasts for specific days
2. Extra information (wind speed, humidity?)