Skip to content

Commit

Permalink
Merge pull request #2 from ibm-cloud-solutions/issue/1
Browse files Browse the repository at this point in the history
updates to links, badges and cleanup
  • Loading branch information
aeweidne committed Aug 2, 2016
2 parents 6c68ab0 + 85e255a commit 40565e7
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 27 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[![Build Status](https://travis-ci.org/ibm-cloud-solutions/hubot-ibmcloud-twitter.svg?branch=master)](https://travis-ci.org/ibm-cloud-solutions/hubot-ibmcloud-twitter)
[![Coverage Status](https://coveralls.io/repos/github/ibm-cloud-solutions/hubot-ibmcloud-twitter/badge.svg?branch=cleanup)](https://coveralls.io/github/ibm-cloud-solutions/hubot-ibmcloud-twitter?branch=master)
[![Dependency Status](https://dependencyci.com/github/ibm-cloud-solutions/hubot-ibmcloud-twitter/badge)](https://dependencyci.com/github/ibm-cloud-solutions/hubot-ibmcloud-twitter)
[![npm](https://img.shields.io/npm/v/hubot-ibmcloud-twitter.svg?maxAge=2592000)](https://www.npmjs.com/package/hubot-ibmcloud-twitter)

# hubot-ibmcloud-twitter

A hubot script for automated tweeting based on events on the IBM Cloud.
Expand All @@ -10,7 +15,7 @@ A hubot script for automated tweeting based on events on the IBM Cloud.
* [License](#license)
* [Contribute](#contribute)

## Usage <a id="usage"></a>
## Usage

Steps for adding this to your existing hubot:

Expand All @@ -34,23 +39,23 @@ HUBOT_TWEETER_ACCOUNTS=<Please see below>
```
5. Start up your bot & off to the races!

## Commands <a id="commands"></a>
## Commands
- edit tweets, list tweets, edit events, enable/disable
- `hubot twitter monitoring help` - Show available commands in the twitter monitoring category.
- `hubot twitter monitoring enable|disable` - Enable|Disable automatic tweeting.
- `hubot twitter monitoring list tweets` - Show the list of events and their associated tweets.
- `hubot twitter monitoring edit tweets` - Edit the tweet for a given event.
- `hubot twitter monitoring edit events` - Edit which events we will tweet about.

## Hubot Adapter Setup <a id="hubot-adapter-setup"></a>
## Hubot Adapter Setup

Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:
- [Slack setup](./docs/adapters/slack.md)
- [Facebook Messenger setup](./docs/adapters/facebook.md)
- [Slack setup](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-twitter/blob/master/docs/adapters/slack.md)
- [Facebook Messenger setup](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-twitter/blob/master/docs/adapters/facebook.md)

## Development <a id="development"></a>
## Development

Please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) before starting any work. Steps for running this script for development purposes:
Please refer to the [CONTRIBUTING.md](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-twitter/blob/master/CONTRIBUTING.md) before starting any work. Steps for running this script for development purposes:

### Configuration Setup

Expand Down Expand Up @@ -85,13 +90,13 @@ Hubot supports a variety of adapters to connect to popular chat clients.

If you just want to use:
- Terminal: run `npm run start`
- [Slack: link to setup instructions](docs/adapters/slack.md)
- [Facebook Messenger: link to setup instructions](docs/adapters/facebook.md)
- [Slack: link to setup instructions](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-twitter/blob/master/docs/adapters/slack.md)
- [Facebook Messenger: link to setup instructions](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-twitter/blob/master/docs/adapters/facebook.md)

## License <a id="license"></a>
## License

See [LICENSE.txt](./LICENSE.txt) for license information.
See [LICENSE.txt](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-twitter/blob/master/LICENSE.txt) for license information.

## Contribute <a id="contribute"></a>

Please check out our [Contribution Guidelines](./CONTRIBUTING.md) for detailed information on how you can lend a hand.
Please check out our [Contribution Guidelines](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-twitter/blob/master/CONTRIBUTING.md) for detailed information on how you can lend a hand.
27 changes: 12 additions & 15 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,47 +7,44 @@
"url": "https://github.com/ibm-cloud-solutions/hubot-ibmcloud-twitter",
"type": "git"
},
"publishConfig": {
"registry": "http://bot-npm.ng.bluemix.net"
},
"scripts": {
"start": "source config/env && hubot -a shell",
"slack": "source config/env && hubot -a slack",
"facebook": "source config/env && hubot -a fb",
"lint": "eslint src/**/*.js test/*.js index.js",
"postinstall": "initDb src/nlc/NLC.json",
"test": ". test/.env && mocha test",
"coverage": ". test/.env && istanbul cover -x 'index.js' -x '**/coverage/**' -x '**/tools/**' --include-all-sources --report lcov --report cobertura --report text --dir ./gh-pages/coverage _mocha -- test"
"coverage": ". test/.env && istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"
},
"keywords": [
"hubot",
"hubot-scripts",
"bluemix",
"cloud",
"slack"
"slack",
"ibm",
"ibm cloud"
],
"author": "ibm-cloud-solutions",
"license": "Apache-2.0",
"devDependencies": {
"hubot-ibmcloud-auth": ">=0.0.8",
"hubot-ibmcloud-formatter": ">=0.0.10",
"hubot-ibmcloud-nlc": ">=0.0.21",
"chai": "^3.5.0",
"coffee-script": "^1.10.0",
"coveralls": "^2.11.12",
"eslint": "^2.9.0",
"eslint-config-strongloop": "^2.0.1",
"hubot": "^2.19.0",
"hubot-fb": "^3.0.0",
"hubot-help": "^0.2.0",
"hubot-ibmcloud-auth": "latest",
"hubot-ibmcloud-formatter": "latest",
"hubot-ibmcloud-nlc": "latest",
"hubot-shell": "^1.0.2",
"hubot-slack": "^3.4.2",
"hubot-test-helper": "^1.4.4",
"istanbul": "0.4.0",
"istanbul-cobertura-badger": "1.2.1",
"mocha": "^2.4.5",
"nock": "^8.0.0",
"rewire": "2.5.1",
"shelljs": "^0.7.0"
"nock": "^8.0.0"
},
"peerDependencies": {
"hubot": "^2.19.0",
Expand All @@ -61,10 +58,10 @@
"index.js"
],
"dependencies": {
"hubot-ibmcloud-cognitive-lib": ">=0.0.19",
"hubot-ibmcloud-cognitive-lib": "latest",
"hubot-emit-tweeter": "latest",
"hubot-ibmcloud-utils": ">=0.0.6",
"hubot-ibmcloud-activity-emitter": ">=0.0.2",
"hubot-ibmcloud-utils": "latest",
"hubot-ibmcloud-activity-emitter": "latest",
"hubot-conversation": "^1.1.1"
}
}

0 comments on commit 40565e7

Please sign in to comment.