asdfx/phergie-irc-plugin-react-apixu-weather

Phergie plugin for returning weather information for a given location.

1.0.0 2019-02-04 13:21 UTC

This package is auto-updated.

Last update: 2024-04-05 01:28:00 UTC


README

Phergie plugin for returning weather information for a given location.

About

This plugin provides a method for performing weather lookups for a specified town/city/zip code from the Apixu API.

Install

The recommended method of installation is through composer.

composer require asdfx/phergie-irc-plugin-react-apixu-weather

See Phergie documentation for more information on installing and enabling plugins.

Configuration

This plugin requires the Command plugin to recognise commands.

If you're new to Phergie or Phergie plugins, see the Phergie setup instructions for more information. Otherwise, add the following references to your config file:

return [
    // ...
    'plugins' => [
        new \Phergie\Irc\Plugin\React\Command\Plugin,   // dependency
	new \Asdfx\Phergie\Plugin\Weather\Plugin(['apiKey' => 'YOUR API KEY GOES HERE']),
    ]
]

The provider is Apixu, which requires a free api key to use (you can get one from here). To use Apixu, you only need to provide the API key.

Current request limits:

  • Apixu: 10,000/month

License

Released under the MIT License. See LICENSE.