PsychoticNinja/JLU5-SupyPlugins
1
0
Fork 0
mirror of https://github.com/jlu5/SupyPlugins.git synced 2025-05-05 09:50:54 -05:00
Code Issues Projects Releases Wiki Activity

NuWeather: add a blurb about geocoding backends

Browse Source 
[skip ci]

Closes #84.
This commit is contained in:
James Lu 2019-03-16 20:43:13 -07:00
parent 8d03d73e4e
commit 31e33babdd
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
NuWeather/README.md
View File

@ -58,3 +58,15 @@ config plugins.NuWeather.DBAddressingMode nicks
5) Load the plugin again for these changes to take effect. 5) Load the plugin again for these changes to take effect.
(If you're comfortable with re-creating your database from scratch, the other options tell NuWeather to save location by Supybot account (the default) or ident@host.) (If you're comfortable with re-creating your database from scratch, the other options tell NuWeather to save location by Supybot account (the default) or ident@host.)
## Location lookup (Geocoding) backends
* Apixu provides weather lookup by place name directly, and does not need further configuration.
* Dark Sky requires a separate lookup to translate place names into GPS coordinates, a process known as **geocoding**.
The default backend for geocoding is [OpenStreetMap's Nominatim]((https://nominatim.openstreetmap.org/)) service, and can be configured via the `plugins.NuWeather.geocodeBackend` option.
Other supported options include [Google Maps](https://developers.google.com/maps/documentation/geocoding/start) and [OpenCage](https://opencagedata.com/),
which may provide more relevant results for North America (e.g. U.S. ZIP codes). These services both require API keys: [Google Maps](https://developers.google.com/maps/documentation/geocoding/get-api-key) (credit card required) | [OpenCage](https://opencagedata.com/api)
API keys for geocoding backends are configured as `plugins.NuWeather.apikeys.BACKENDNAME`.