Add readme

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8039ca2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+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.
+
+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:
+
+Run the following to install the required gems -
+
+gem install
+
+Alternatively, install the 'json' and 'rest-client' Ruby Gems via your package manager.
+
+Usage:
+
+ruby blaweather.rb [location]
+
+e.g:
+
+ruby blaweather.rb London
+ruby blaweather.rb W1A 1AA
+ruby blaweather.r tower bridge
+
+To do:
+
+Specify detailed forecasts for specific days
+Extra information (wind speed, humidity?)
+Forecast further ahead.
\ No newline at end of file