summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoe Robinson <joe@lc8n.com>2015-09-23 00:17:38 +0100
committerJoe Robinson <joe@lc8n.com>2015-09-23 00:17:38 +0100
commita83d9f0dbcfd2e61294e2819539df6c7a3fea133 (patch)
tree63f0e56bfd7fd33dbfb993bbe5ef6b96759bd002
parent741a8b949b3a1528650a822a3a030a8ba6629bab (diff)
Add formatting to readme
-rw-r--r--README.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/README.md b/README.md
index 8039ca2..9fe2fcc 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-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,26 +8,26 @@ 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 -
-gem install
+`gem install`
Alternatively, install the 'json' and 'rest-client' Ruby Gems via your package manager.
-Usage:
+##Usage:
-ruby blaweather.rb [location]
+`ruby blaweather.rb [location]`
e.g:
-ruby blaweather.rb London
-ruby blaweather.rb W1A 1AA
-ruby blaweather.r tower bridge
+`ruby blaweather.rb London`
+`ruby blaweather.rb W1A 1AA`
+`ruby blaweather.r tower bridge`
-To do:
+##To do:
-Specify detailed forecasts for specific days
-Extra information (wind speed, humidity?)
-Forecast further ahead. \ No newline at end of file
+1. Specify detailed forecasts for specific days
+2. Extra information (wind speed, humidity?)
+3. Forecast further ahead. \ No newline at end of file