From 62d6f0d400146e60ec0f23d9162d166001a91b5e Mon Sep 17 00:00:00 2001 From: James Lu Date: Fri, 23 Sep 2016 19:36:23 -0700 Subject: [PATCH] Weather: refresh README --- Weather/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Weather/README.md b/Weather/README.md index ed17938..96d7a67 100644 --- a/Weather/README.md +++ b/Weather/README.md @@ -2,7 +2,7 @@ ## Installation -1) Download the plugin, either via Git clone or Limnoria's PluginDownloader (`install GLolol Weather`). +1) Download the plugin, either via Git or Limnoria's PluginDownloader (`install GLolol Weather`). 2) Load the plugin: @@ -11,7 +11,7 @@ ``` 3) [Fetch an API key from Wunderground](http://www.wunderground.com/weather/api/) by signing up (free). -Once getting this key, you will need to set it on your bot before things will work. +Once you get this key, you will need to set it up on your bot: ``` /msg config plugins.Weather.apiKey @@ -19,22 +19,22 @@ Once getting this key, you will need to set it on your bot before things will wo ## Example Usage -When calling the `weather` command, you can use zip codes (10002), cities (New York, NY), etc. +When calling the `weather` command, you can provide location in many forms, including city names (e.g. Vancouver), ZIP codes (e.g. 10002), "city, country" pairs (e.g. "Sydney, Australia", and [ICAO airport codes](https://en.wikipedia.org/wiki/International_Civil_Aviation_Organization_airport_code) (e.g. KJFK) + ``` @weather 10002 New York, NY :: Mostly Cloudy :: 55F/12C (Humidity: 53%) | Monday: Mostly cloudy. Low 11C. Monday Night: Cloudy. Slight chance of a rain shower. Low 11C. Winds ENE at 10 to 15 km/h. ``` -Users can also have their location remembered by the plugin's internal database so that -they will not have to continually type in their location. +Users can also have their location remembered by the bot so that they don't have to continually type in their location. ``` @setweather 10002 Done. ``` -This now allows a user to type in the weather command without any arguments: +This allows a user to use the `weather` command without any arguments: ``` @weather @@ -44,6 +44,6 @@ This now allows a user to type in the weather command without any arguments: Users can also have the bot remember their preferred options, such as using metric units when displaying forecasts: ``` - @setuser metric False + @setuser metric True Done. ```