From 7b6d7ea441e06bd705d840695a53e7e91c145ca0 Mon Sep 17 00:00:00 2001 From: James Lu Date: Mon, 9 Nov 2015 16:38:45 -0800 Subject: [PATCH] Weather: update README [skip ci] --- Weather/README.md | 28 +++++----------------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/Weather/README.md b/Weather/README.md index dbe0432..ed17938 100644 --- a/Weather/README.md +++ b/Weather/README.md @@ -1,17 +1,8 @@ -[![Build Status](https://travis-ci.org/GLolol/Supybot-Weather.svg?branch=master)](https://travis-ci.org/GLolol/Supybot-Weather) # 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 `~/limnoria/plugins`), and run: - -``` -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`. +1) Download the plugin, either via Git clone or Limnoria's PluginDownloader (`install GLolol Weather`). 2) Load the plugin: @@ -28,20 +19,11 @@ 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. Weather Underground is pretty -intelligent here. +When calling the `weather` command, you can use zip codes (10002), cities (New York, NY), etc. ``` @weather 10002 - New York, NY :: Rain :: 52F | Visibility: 4.0mi | Saturday: Rain. High around 55F... -``` - -## Features - -There are a ton of options to configure. You can find these via: - -``` -/msg bot config search Weather + 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 @@ -52,14 +34,14 @@ they will not have to continually type in their location. Done. ``` -This now allows a user to type in the weather command w/o any arguments: +This now allows a user to type in the weather command without any arguments: ``` @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: +Users can also have the bot remember their preferred options, such as using metric units when displaying forecasts: ``` @setuser metric False