<commit_before># twitch-bot [![CircleCI](https://circleci.com/gh/kritzware/twitch-bot.svg?style=svg&circle-token=<PASSWORD>)](https://circleci.com/gh/kritzware/twitch-bot)
Easily create chat bots for Twitch.tv

## Install
Install via NPM
```
$ npm install twitch-bot
```

## Example
```javascript
const TwitchBot = require('twitch-bot')

const Bot = new TwitchBot({
  username: 'Kappa_Bot'
  oauth: 'oauth:<PASSWORD>',
  channel: 'twitch'
})

Bot.on('join', () => {

  Bot.on('message', chatter => {
    if(chatter.message === '!test') {
      Bot.say('Command executed! PogChamp')
    }
  })
})

Bot.on('error', err => {
  console.log(err)
})
```

## Index
- [Events](https://github.com/kritzware/twitch-bot#events)
  - [`join`](https://github.com/kritzware/twitch-bot#join---)
  - [`message`](https://github.com/kritzware/twitch-bot#message---chatter-object)
  - [`timeout`](https://github.com/kritzware/twitch-bot#timeout---event-object)
  - [`ban`](https://github.com/kritzware/twitch-bot#timeout---event-object)
  - [`error`](https://github.com/kritzware/twitch-bot#error---err-object)
  - [`close`](https://github.com/kritzware/twitch-bot#close---)
- [Methods](https://github.com/kritzware/twitch-bot#methods)
  - [`say()`](https://github.com/kritzware/twitch-bot#saymessage-string-err-callback)
  - [`timeout()`](https://github.com/kritzware/twitch-bot#timeoutusername-string-duration-int-reason-string)
  - [`ban()`](https://github.com/kritzware/twitch-bot#banusername-string-reason-string)
  - [`close()`](https://github.com/kritzware/twitch-bot#close)

## Events<commit_msg>Fixed docs index link<commit_after># twitch-bot [![CircleCI](https://circleci.com/gh/kritzware/twitch-bot.svg?style=svg&circle-token=3d338af28058e84dde13bee88751a50f55aefab3)](https://circleci.com/gh/kritzware/twitch-bot)
Easily create chat bots for Twitch.tv

## Install
Install via NPM
```
$ npm install twitch-bot
```

## Example
```javascript
const TwitchBot = require('twitch-bot')

const Bot = new TwitchBot({
  username: 'Kappa_Bot'
  oauth: 'oauth:<PASSWORD>',
  channel: 'twitch'
})

Bot.on('join', () => {

  Bot.on('message', chatter => {
    if(chatter.message === '!test') {
      Bot.say('Command executed! PogChamp')
    }
  })
})

Bot.on('error', err => {
  console.log(err)
})
```

## Index
- [Events](https://github.com/kritzware/twitch-bot#events)
  - [`join`](https://github.com/kritzware/twitch-bot#join---)
  - [`message`](https://github.com/kritzware/twitch-bot#message---chatter-object)
  - [`timeout`](https://github.com/kritzware/twitch-bot#timeout---event-object)
  - [`ban`](https://github.com/kritzware/twitch-bot#ban---event-object)
  - [`error`](https://github.com/kritzware/twitch-bot#error---err-object)
  - [`close`](https://github.com/kritzware/twitch-bot#close---)
- [Methods](https://github.com/kritzware/twitch-bot#methods)
  - [`say()`](https://github.com/kritzware/twitch-bot#saymessage-string-err-callback)
  - [`timeout()`](https://github.com/kritzware/twitch-bot#timeoutusername-string-duration-int-reason-string)
  - [`ban()`](https://github.com/kritzware/twitch-bot#banusername-string-reason-string)
  - [`close()`](https://github.com/kritzware/twitch-bot#close)

## Events
{'fraction_non_alphanumeric': 0.22048719550281073, 'fraction_numerical': 0.007183010618363523, 'mean_word_length': 4.522413793103448, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 12, 'https://': 28, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1101964', 'n_tokens_mistral': 1227, 'n_tokens_neox': 1191, 'n_words': 114}