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

NuWeather: update README

Browse Source
This commit is contained in:
James Lu 2018-12-30 23:51:07 -08:00
parent 2291a174d3
commit bed8a0669b
3 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
NuWeather/README.md
View File

@ -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 <your-preferred-location>`
3) Configure it: `/msg yourbot config plugins.nuweather.apikeys.BACKENDNAME YOUR-API-KEY`
4) Obtain weather: `weather [<optional location>]`
5) Set your default weather location: `setweather <your-preferred-location>`
6) Obtain weather: `weather [<optional location>]`

2
NuWeather/plugin.py
View File

@ -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.

2
README.md
View File

@ -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.