Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.29 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.29 KB

tmi.js

Build Status Downloads Npm Version Node Version Issues

The best place to start with tmi.js is our documentation page.

This module currently support Node.js 4.x and every browser that support WebSockets. The current WebSocket protocol being used by this module is HyBi drafts 13-17.

Install

Node.js

Install with npm and jump to the configuration page to get started.

npm install tmi.js --save

CDN provided by MaxCDN

To use the tmi.js CDN, just reference the file directly in the script tag.

<script src="//cdn.tmijs.org/js/0.0.24/tmi.js"></script>

SourceMap: //cdn.tmijs.org/js/0.0.24/tmi.js.map

Community

Contributors

In order of the most commits:

Contributing guidelines

Please review the guidelines for contributing of the tmi.js repository. We reserve the right to refuse a Pull Request if it does not meet the requirements.