Comparing version 0.0.2 to 0.0.3
@@ -19,5 +19,5 @@ 'use strict'; | ||
var Bot = function () { | ||
function Bot(token) { | ||
_classCallCheck(this, Bot); | ||
var Ghee = function () { | ||
function Ghee(token) { | ||
_classCallCheck(this, Ghee); | ||
@@ -38,3 +38,3 @@ this.slack = new _client2.default.RtmClient(token, { | ||
_createClass(Bot, [{ | ||
_createClass(Ghee, [{ | ||
key: 'loggedin', | ||
@@ -117,6 +117,6 @@ value: function loggedin() { | ||
return Bot; | ||
return Ghee; | ||
}(); | ||
function listen(target, key) { | ||
function ghee(target, key) { | ||
listeners[key] = target[key]; | ||
@@ -129,2 +129,2 @@ } | ||
module.exports = { Bot: Bot, listen: listen }; | ||
module.exports = { Ghee: Ghee, ghee: ghee }; |
{ | ||
"name": "ghee", | ||
"version": "0.0.2", | ||
"version": "0.0.3", | ||
"description": "ES6/ES7 Slack Bot Wrapper", | ||
@@ -5,0 +5,0 @@ "main": "lib/ghee.js", |
@@ -1,8 +0,12 @@ | ||
# ghee | ||
# ghee | ||
--- | ||
ghee is an ES6 based wrapper/helper for Slack's official client. It is specifically built to be used with ES7 decorators to make defining methods the bot can respond to easy to define without much overhead. | ||
ghee is an ES6 based wrapper/helper for Slack's official client. It is | ||
specifically built to be used with ES7 decorators to make defining methods the | ||
bot can respond to easy to define without much overhead. | ||
### Why "ghee"? | ||
It started off as the basis for ghebot, a bot to assist in monitor and alerting for GitHub Enterprise. Ghee is now the underlying framework for ghebot. Also, _it's clear to use and smooth as butter_. | ||
It started off as the basis for ghebot, a bot to assist in monitor and alerting | ||
for GitHub Enterprise. ghee is now the underlying framework for ghebot. Also, | ||
_it's clear to use and smooth as butter_. | ||
@@ -12,3 +16,3 @@ ### Install | ||
```sh | ||
$ npm install --save elliottcarlson/ghee | ||
$ npm install --save ghee | ||
``` | ||
@@ -20,4 +24,3 @@ | ||
$ npm init | ||
$ npm install --save elliottcarlson/ghee | ||
$ npm install --save | ||
$ npm install --save ghee | ||
``` |
25
5805