From c85183a8ddfe82276e3d11d8d7b3e7717e8f7bd1 Mon Sep 17 00:00:00 2001 From: James Lu Date: Sat, 28 Apr 2018 08:32:32 -0700 Subject: [PATCH] Weather: advertise more supported location forms [skip ci] --- Weather/README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/Weather/README.md b/Weather/README.md index 96d7a67..12aedc2 100644 --- a/Weather/README.md +++ b/Weather/README.md @@ -17,16 +17,25 @@ Once you get this key, you will need to set it up on your bot: /msg config plugins.Weather.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: ``` @weather 10002 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. ``` @@ -41,6 +50,8 @@ This allows a user to use the `weather` command without any arguments: 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: ```