PsychoticNinja/JLU5-SupyPlugins
1
0
Fork 0
mirror of https://github.com/jlu5/SupyPlugins.git synced 2025-04-29 23:11:07 -05:00
Code Issues Projects Releases Wiki Activity

Weather: update README [skip ci]

Browse Source
This commit is contained in:
James Lu 2015-11-09 16:38:45 -08:00
parent 7b2da8e25e
commit 7b6d7ea441
1 changed files with 5 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Weather/README.md
View File

@ -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.
```
<GLolol> @weather 10002
<Atlas> 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
<Atlas> 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.
<Atlas> 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:
```
<GLolol> @weather
<Atlas> 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:
```
<GLolol> @setuser metric False