slackbotapi
Version:
a node.js API using Slack their RTM API
46 lines (31 loc) • 2.18 kB
Markdown
SlackbotAPI
============
[](https://github.com/xBytez/slackbotapi/stargazers)
[](https://github.com/xBytez/slackbotapi/issues)
[](https://github.com/xBytez/slackbotapi)
[](http://inch-ci.org/github/xBytez/slackbotapi)
[](https://codeclimate.com/github/xBytez/slackbotapi)
[](https://gitter.im/xBytez/slackbotapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
A Node.JS module for Slack's RTM API
## Setup
#### Requirements
>The following resources are needed in order to run `slackbotapi`:
* Modules: `eventemitter3`, `jethro`, `request` and `ws`
* A valid Slack API Token
#### Installation
Installing slackbotapi is as simple as running the following command:
```npm install slackbotapi```
## Usage
After installing this module and its [dependencies](#Requirements), you can check the [example_bot.js](https://github.com/xBytez/slackbotapi/blob/master/examples/example_bot.js) to learn the basics.
## Cool projects built on slackbotapi
* [Slackslime by @franciskim](https://github.com/franciskim/slackslime)
* [Slackquizbot by @codebyfire](https://github.com/codebyfire/slackquizbot)
* [Slackweatherbot by @franciskim](https://github.com/franciskim/Slackweatherbot)
* [Slack-file-cleaner by @Ad237](https://github.com/Ad237/slack-file-cleaner)
If you want your project to be listed here, please let us know by creating an issue with the link to your project. Chances are we'll list it here!
## Contact us
You can join the #slackbotapi channel over at https://slack.radiant.dj. (If you are already registered you can find us at https://radiantdj.slack.com) If you prefer not to join yet another Slack team, feel free to join Gitter or post an issue.