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

NuWeather: update list of available backends

Browse Source 
[skip ci]
This commit is contained in:
James Lu 2019-03-16 20:31:40 -07:00
parent fa4921776c
commit 8d03d73e4e
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
NuWeather/README.md
View File

@ -1,23 +1,27 @@
# NuWeather
A weather plugin for Limnoria. It supports multiple backends:
A weather plugin for Limnoria. It supports multiple weather and geocoding backends:
- [Dark Sky](https://darksky.net) (default)
- [Apixu](https://www.apixu.com/)
#### Weather Backends
- [Dark Sky](https://darksky.net) (default, API key required)
- [Apixu](https://www.apixu.com/) (API key required)
For the Dark Sky backend, [OpenStreetMap Nominatim](https://nominatim.openstreetmap.org/) is used to translate locations into latitude/longitude pairs.
#### Geocoding Backends
- [OpenStreetMap Nominatim](https://nominatim.openstreetmap.org/) (default, no API key required)
- [Google Maps](https://developers.google.com/maps/documentation/geocoding/start) (API key required)
- [OpenCage](https://opencagedata.com/) (API key required)
## Quick start
1) Pick your preferred backend: `config help plugins.nuweather.defaultbackend`
1) Pick your preferred weather backend: `config help plugins.NuWeather.defaultBackend`
2) Grab an API key. [Dark Sky](https://darksky.net/dev) | [Apixu](https://www.apixu.com/)
3) Configure it: `/msg yourbot config plugins.nuweather.apikeys.BACKENDNAME YOUR-API-KEY`
3) Configure it: `/msg yourbot config plugins.NuWeather.apikeys.BACKENDNAME YOUR-API-KEY`
5) Set your default weather location: `setweather <your-preferred-location>`
4) Set your default weather location: `setweather <your-preferred-location>`
6) Obtain weather: `weather [<optional location>]`
5) Obtain weather: `weather [<optional location>]`
## Migrating from the Weather plugin