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

Weather: advertise more supported location forms

Browse Source 
[skip ci]
This commit is contained in:
James Lu 2018-04-28 08:32:32 -07:00 committed by GitHub
parent d28233138f
commit c85183a8dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Weather/README.md
View File

@ -17,16 +17,25 @@ Once you get this key, you will need to set it up on your bot:
/msg <yourbot> config plugins.Weather.apiKey <APIKEY> /msg <yourbot> config plugins.Weather.apiKey <APIKEY>
``` ```
## Example Usage ## Usage
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) When calling the `weather` command, you can provide locations in one of many forms:
- City names (e.g. Vancouver)
- U.S. ZIP codes (e.g. 10002)
- Canadian, U.K. postal codes (e.g. V6C 3T4)
- City, country pairs (e.g. "Sydney, Australia", "Paris, France")
- City, state/province pairs (e.g. "Washington, D.C.", "Kitchener, Ontario")
- [ICAO airport codes](https://en.wikipedia.org/wiki/International_Civil_Aviation_Organization_airport_code) (e.g. KJFK)
Example:
``` ```
<GLolol> @weather 10002 <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. <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.
``` ```
### Saving locations
Users can also have their location remembered by the bot so that they don't 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.
``` ```
@ -41,6 +50,8 @@ This allows a user to use the `weather` command without any arguments:
<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. <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.
``` ```
### User options
Users can also have the bot remember their preferred options, such as using metric units when displaying forecasts: Users can also have the bot remember their preferred options, such as using metric units when displaying forecasts:
``` ```