add some tutorial

pull/1/head
Mallory Hancock 2017-10-02 10:28:39 -07:00
parent 1042ed6080
commit 2b5c63de01
1 changed files with 20 additions and 1 deletions

View File

@ -1,5 +1,24 @@
# pinhook
a pluggable irc bot framework in python
## currently in very early stages and may change wildly until final release
# Currently in very early stages and may change wildly until final release
## Tutorial
### Installation
```
$ pip install git+git://github.com/archangelic/pinhook.git
```
### Creating the Bot
To create the bot, just create a python file with the following:
```python
import pinhook.bot
bot = pinhook.bot.Bot(channels=['#foo', '#bar'], nickname='ph-bot', server='irc.freenode.net')
bot.start()
```
This will start a basic bot and look for plugins in the 'plugins' directory to add functionality.
Optionally, you can change the `port` and add a list of operators with the `ops` argument.