pschwisow/phergie-irc-plugin-react-altnick

Phergie plugin for switching to alternate nicks when primary is not available

2.0.0 2016-04-22 22:30 UTC

README

Phergie plugin for switching to alternate nicks when primary is not available.

Build Status Code Climate Test Coverage

Install

The recommended method of installation is through composer.

{
    "require": {
        "pschwisow/phergie-irc-plugin-react-altnick": "~2"
    }
}

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

Configuration

return [
    'plugins' => [
        // configuration
        new \PSchwisow\Phergie\Plugin\AltNick\Plugin([
            // At least one alternate nick
            'nicks' => [
                'Foo',
                'Foo_',
                'FooBar'
            ],
            // Optional: if primary nickname is in use, reclaim it if it disconnects
            'recovery' => true,
        ])
    ]
];

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 BSD License. See LICENSE.