From 1f12245f0565d696f6651ee8874e3d9034791af6 Mon Sep 17 00:00:00 2001 From: James Lu Date: Thu, 7 May 2015 17:58:30 -0700 Subject: [PATCH] Weather: README updates Some of the plugin's output syntax has changed, along with the 'wunderground' command being renamed to 'weather'. --- README.md | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 27d9f4d..dbe0432 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ [![Build Status](https://travis-ci.org/GLolol/Supybot-Weather.svg?branch=master)](https://travis-ci.org/GLolol/Supybot-Weather) - -# Limnoria plugin for Weather Underground (GLolol's fork) +# Limnoria plugin for Weather Underground ## Installation You will need a working Limnoria bot on Python 2.7/3.2+ for this to work. -1) Go into your Limnoria plugin dir, usually `~/supybot/plugins` and run: +1) Go into your Limnoria plugin dir (usually `~/limnoria/plugins`), and run: ``` -git clone https://github.com/GLolol/Supybot-Weather +git clone https://github.com/GLolol/Supybot-Weather Weather ``` Alternatively, you can fetch this plugin (albeit a slightly older version) via Limnoria's PluginDownloader using: `install GLolol Weather`. @@ -23,25 +22,18 @@ Alternatively, you can fetch this plugin (albeit a slightly older version) via L 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. - ``` /msg config plugins.Weather.apiKey ``` -4) *Optional:* There are some config variables that can be set for the bot. They mainly control output stuff. - -``` -/msg bot config search Weather -``` - ## Example Usage -When calling the `wunderground` command, you can use zip codes (10002), cities (New York, NY), etc. Weather Underground is pretty +When calling the `weather` command, you can use zip codes (10002), cities (New York, NY), etc. Weather Underground is pretty intelligent here. ``` - @wunderground 10002 - New York, NY :: Rain :: 52F | Visibility: 4.0mi | Saturday: Rain. High around 55F... + @weather 10002 + New York, NY :: Rain :: 52F | Visibility: 4.0mi | Saturday: Rain. High around 55F... ``` ## Features @@ -56,20 +48,20 @@ Users can also have their location remembered by the plugin's internal database they will not have to continually type in their location. ``` - @setweather 10002 - I have changed spline's weather ID to 10002 + @setweather 10002 + Done. ``` This now allows a user to type in the weather command w/o any arguments: ``` - @wunderground - Manchester, NH :: Rain :: 45F | Visibility: 10.0mi | Saturday: Occasional light rain. High 56F. ... + @weather + New York, NY :: Clear :: 64F/17C | Wind: N@7kph | Thursday: Clear. Low 14C. Thursday Night: A clear sky. Low 14C. Winds SSE at 10 to 15 km/h. ``` Users can also have the bot remember their preferred options, such as using metric units when displaying weather: ``` - @setuser metric False - I have changed spline's metric setting to 0 + @setuser metric False + Done. ```