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

Weather: refresh README

Browse Source
This commit is contained in:
James Lu 2016-09-23 19:36:23 -07:00 committed by GitHub
parent eb96578e91
commit 62d6f0d400
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Weather/README.md
View File

@ -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 <yourbot> config plugins.Weather.apiKey <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)
```
<GLolol> @weather 10002
<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
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.
```
<GLolol> @setweather 10002
<Atlas> 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:
```
<GLolol> @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:
```
<GLolol> @setuser metric False
<GLolol> @setuser metric True
<Atlas> Done.
```