diff --git a/NuWeather/README.md b/NuWeather/README.md index de6f3da..a2c4fc3 100644 --- a/NuWeather/README.md +++ b/NuWeather/README.md @@ -1,13 +1,20 @@ ## NuWeather -A weather plugin for Limnoria. It currently uses [Apixu](https://www.apixu.com/), but more backends will be added soon. +A weather plugin for Limnoria. It supports multiple backends: + +- [Dark Sky](https://darksky.net) (default) +- [Apixu](https://www.apixu.com/) + +For the Dark Sky backend, [OpenStreetMap Nominatim](https://nominatim.openstreetmap.org/) is used to translate locations into latitude/longitude pairs. ### Quick start -1) Grab an API key from https://www.apixu.com/ +1) Pick your preferred backend: `config help plugins.nuweather.defaultbackend` -2) Configure it: `/msg yourbot config plugins.nuweather.apikeys.apixu YOUR-API-KEY` +2) Grab an API key. [Dark Sky](https://darksky.net/dev) | [Apixu](https://www.apixu.com/) -3) Set your default weather location: `setweather ` +3) Configure it: `/msg yourbot config plugins.nuweather.apikeys.BACKENDNAME YOUR-API-KEY` -4) Obtain weather: `weather []` +5) Set your default weather location: `setweather ` + +6) Obtain weather: `weather []` diff --git a/NuWeather/plugin.py b/NuWeather/plugin.py index 300e2ed..3e665df 100644 --- a/NuWeather/plugin.py +++ b/NuWeather/plugin.py @@ -315,7 +315,7 @@ class NuWeather(callbacks.Plugin): s += _(' | \x02UV:\x02 %s') % self._format_uv(uv) # This may seem a bit counterintuitive, but the hourly summary is actually a summary of - # the hourly data blocks spanning 48 hours. So, it is more of a daily weather forecast. + # "hourly" data blocks spanning 48 hours. So, it is more of a daily weather forecast. # Similarly, the daily summary is actually a summary of weekly info. # We don't show individual data packets in either of these because that would be way too # long for IRC. diff --git a/README.md b/README.md index ee676a2..408fc39 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Most of these plugins also have their own READMEs in their folders; you can usua - Anti-abuse script; prevents the bot from triggering other bots by modifying its output slightly. For more information, see [NoTrigger/README.md](NoTrigger/README.md). ##### [NuWeather](NuWeather/README.md) -- A weather plugin for Limnoria. It currently uses [Apixu](https://www.apixu.com/), but more backends will be added soon. +- A weather plugin for Limnoria. It supports [Dark Sky](https://darksky.net) and [Apixu](https://www.apixu.com/) as backends. ##### [OperUp](OperUp/README.md) - Allows Supybot to oper up on configured networks, automatically (on connect) and on demand.