README

Phergie plugin to remind you when the pizza is done.

Install

The recommended method of installation is through composer.

composer require sitedyno/phergie-reminders

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

Configuration

Configuration is optional.

return [
    'plugins' => [
        // dependencies
        new \Phergie\Irc\Plugin\React\Command\Plugin,

        // optional dependencies
        new \Phergie\Irc\Plugin\React\CommandHelp\Plugin([
            // List of plugins that subscribe to command events
            // Used to return a list of available commands to users
            'plugins' => [
                new \Sitedyno\Phergie\Plugin\Reminders\Plugin,
            ]
        ]),

        // configuration
        new \Sitedyno\Phergie\Plugin\Reminders\Plugin([
            // path to the reminder cache
            'cachePath' => '/home/coolperson/phergie',
            // file name of the reminder cache file
            'cacheFile' => '.phergie-reminders',
            // If true the plugin responds in private message only
            'forcePMs' => true,
            // If a user has a list of reminders larger than this value
            // the repsonse  will be in private message
            'maxListSize' => 5,
        ])
    ]
];

For more info about dependency configuration see Command Plugin and Command Help Plugin

Tests

To run the unit test suite:

curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit

License

Released under the MIT License. See LICENSE.