Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Havvy committed Jan 17, 2014
1 parent 02efda1 commit 3bde569
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Tennu is an IRC bot framework written in Node.js

[![NPM](https://nodei.co/npm/tennu.png?downloads=true&stars=true)](https://nodei.co/npm/tennu/)

See [Our Website](https://tennu.github.io) for (soon) better documentation.

----------

## Basic Usage ##
Expand Down Expand Up @@ -52,7 +56,7 @@ A network configuration object has the following properties:
* nickserv - Nickname of nickserv service. Defaults to "nickserv".
* trigger - Command character to trigger commands with. By default, '!'.
* channels - Array of channels to autojoin. _Example:_ ["#help", "#tennu"]
* plugins - An array of module names that the bot requires.
* modules - An array of module names that the bot requires.

Other plugins may use additional properties.

Expand All @@ -66,6 +70,7 @@ The following properties will be renamed:
* nick -> nickname
* trigger -> command-trigger
* password -> auth-password (or something better...)
* modules -> plugins

## Dependency Management ##

Expand Down Expand Up @@ -413,4 +418,4 @@ Between all projects (tennu, tennu-modules, irc-socket), there are over 100 test

* [Tennu's Website](https://tennu.github.io/)
* [IRC Specifications and other helpful tables](https://www.alien.net.au/irc/)
* [IRC Wiki](http://www.irc-wiki.org/)
* [IRC Wiki](http://www.irc-wiki.org/)

0 comments on commit 3bde569

Please sign in to comment.