Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kegsay committed Aug 17, 2015
1 parent 627625b commit b6bab70
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,12 @@ You can access more detailed documentation for this module at [Read the Docs](ht
The `node-irc` library isn't well maintained and there are a number of issues which are impacting development of the [Matrix-IRC application service](http://github.com/matrix-org/matrix-appservice-irc). We made the decision to fork the project in order to improve reliability of the application service. A summary of modifications from `[email protected]` are below:
- https://github.com/matrix-org/node-irc/pull/1 - Manifested as [BOTS-80](https://matrix.org/jira/browse/BOTS-80)
- https://github.com/matrix-org/node-irc/pull/4 - Manifested as [BOTS-73] (https://matrix.org/jira/browse/BOTS-73)
- Addition of `onNickConflict()` option which is called on `err_nicknameinuse`. This function should return the next nick to try. Defaults to suffixing monotonically increasing integers.
- Addition of `onNickConflict()` option which is called on `err_nicknameinuse`. This function should return the next nick to try. The function defaults to suffixing monotonically increasing integers. Usage:

```javascript
new Client("server.com", "MyNick", {
onNickConflict: function() {
return "_MyNick_";
}
});
```

0 comments on commit b6bab70

Please sign in to comment.