From 8d03d73e4edfc47eb05bc2c676f7a14017b9584c Mon Sep 17 00:00:00 2001 From: James Lu Date: Sat, 16 Mar 2019 20:31:40 -0700 Subject: [PATCH] NuWeather: update list of available backends [skip ci] --- NuWeather/README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/NuWeather/README.md b/NuWeather/README.md index d4b1b9b..f16f0cb 100644 --- a/NuWeather/README.md +++ b/NuWeather/README.md @@ -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 ` +4) Set your default weather location: `setweather ` -6) Obtain weather: `weather []` +5) Obtain weather: `weather []` ## Migrating from the Weather plugin