Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brucezhang1993/phergie-irc-plugin-react-expressquery


https://github.com/brucezhang1993/phergie-irc-plugin-react-expressquery

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# brucezhang/phergie-irc-plugin-react-expressquery

[Phergie](http://github.com/phergie/phergie-irc-bot-react/) plugin for Query express using api.

[![Build Status](https://secure.travis-ci.org/BruceZhang1993/phergie-irc-plugin-react-expressquery.png?branch=master)](http://travis-ci.org/BruceZhang1993/phergie-irc-plugin-react-expressquery)

## Install

The recommended method of installation is [through composer](http://getcomposer.org).

`composer require brucezhang/phergie-irc-plugin-react-expressquery`

See Phergie documentation for more information on
[installing and enabling plugins](https://github.com/phergie/phergie-irc-bot-react/wiki/Usage#plugins).

## Provided Commands

| Command | Parameters | Description |
|:----------:|-------------------|-----------------------|
| kd/express | [Express ID] | Express status query |
## Configuration

```php
return [
'plugins' => [
// configuration
new \Phergie\Irc\Plugin\React\ExpressQuery\Plugin([

//User-defined commands Default: express/kd
'commands' => array('command1', 'command2', ...),

//Latest {lines} status will be shown Deault: 5
'lines' => 5

])
]
];
```

## Tests

To run the unit test suite:

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

## License

Released under the BSD License. See `LICENSE`.