Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

Commit

Permalink
Document how to get a user's ID.
Browse files Browse the repository at this point in the history
Closes #4. Closes #5.
  • Loading branch information
jimmycuadra committed Jan 11, 2015
1 parent 1548503 commit 2362eca
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,17 @@ Under the hood, lita-irc uses [Cinch](https://github.com/cinchrb/cinch) for the

**Note**: `config.robot.name` is used as Lita's IRC nickname. The `nick` attribute of the Cinch options is overwritten with this value.

### config.robot.admins

Each IRC user has a unique ID that Lita generates and stores the first time that user is encountered. To populate the `config.robot.admins` attribute, you'll need to use these IDs for each user you want to mark as an administrator. If you're using Lita version 4.1 or greater, you can get a user's ID by sending Lita the command `users find NICKNAME_OF_USER`.

### Example

``` ruby
Lita.configure do |config|
config.robot.name = "Lita"
config.robot.adapter = :irc
config.robot.admins = ["eed844bf-2df0-4091-943a-7ee05ef36f4a"]
config.adapters.irc.server = "irc.freenode.net"
config.adapters.irc.channels = ["#litabot"]
config.adapters.irc.user = "Lita"
Expand Down

0 comments on commit 2362eca

Please sign in to comment.