Skip to content

Commit

Permalink
Merge pull request #2 from circuit/markdown
Browse files Browse the repository at this point in the history
Markdown
  • Loading branch information
bettinatop22 committed Aug 4, 2017
2 parents fff118c + cdf2933 commit c26563f
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 26 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# hubot-circuit

[![CircleCI](https://circleci.com/bb/breadboard/hubot-circuit.svg?style=shield)](https://circleci.com/bb/breadboard/hubot-circuit)
[![Coverage Status](https://coveralls.io/repos/bitbucket/breadboard/hubot-circuit/badge.svg)](https://coveralls.io/bitbucket/breadboard/hubot-circuit)
[![Dependency Status](https://gemnasium.com/badges/bitbucket.org/breadboard/hubot-circuit.svg)](https://gemnasium.com/bitbucket.org/breadboard/hubot-circuit)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![CircleCI](https://circleci.com/gh/circuit/hubot-circuit.svg?style=shield)](https://circleci.com/gh/circuit/hubot-circuit)
[![Coverage Status](https://coveralls.io/repos/github/circuit/hubot-circuit/badge.svg)](https://coveralls.io/github/circuit/hubot-circuit)
[![Dependency Status](https://gemnasium.com/badges/github.com/circuit/hubot-circuit.svg)](https://gemnasium.com/github.com/circuit/hubot-circuit)


## Description
This is the [Circuit](http://circuit.com) adapter for [hubot](http://hubot.github.com). Now, you can create your own bots in Circuit and have them easily configured through hubot.
This is the [Circuit](http://circuit.com) adapter for [hubot](http://hubot.github.com). Now, you can create your own bots in Circuit and have them easily configured through hubot.

#### Configuration

Expand All @@ -26,11 +28,11 @@ export HUBOT_CIRCUIT_ADDRESS="YOUR_APP_ADDRESS"
export HUBOT_CIRCUIT_PORT="YOUR_APP_PORT"
export HUBOT_CIRCUIT_SCOPE="YOUR_APP_SCOPE"
```
If you do not specify the optional parameters above the default ones will be loaded.
If you do not specify the optional parameters above the default ones will be loaded.
```
HUBOT_CIRCUIT_ADDRESS="0.0.0.0"
HUBOT_CIRCUIT_PORT="8181"
HUBOT_CIRCUIT_REST_API_URL="https://eu.yourcircuit.com/rest"
HUBOT_CIRCUIT_ADDRESS="0.0.0.0"
HUBOT_CIRCUIT_PORT="8181"
HUBOT_CIRCUIT_REST_API_URL="https://eu.yourcircuit.com/rest"
HUBOT_CIRCUIT_SCOPE="ALL"
```

Expand All @@ -39,11 +41,11 @@ HUBOT_CIRCUIT_SCOPE="ALL"
./bin/hubot -a circuit
```

hubot-circuit uses [Rest API](https://eu.yourcircuit.com/rest/swagger/ui/index.html) and webhooks in order to communicate with Circuit. The default events that are registered through webhooks are the CONVERSATION.ADD_ITEM and CONVERSATION.UPDATE_ITEM. In order to receive events the callback url (HUBOT_CIRCUIT_WEBHOOKS_URL) that you will use must be a secure url.
hubot-circuit uses [Rest API](https://eu.yourcircuit.com/rest/swagger/ui/index.html) and webhooks in order to communicate with Circuit. The default events that are registered through webhooks are the CONVERSATION.ADD_ITEM and CONVERSATION.UPDATE_ITEM. In order to receive events the callback url (HUBOT_CIRCUIT_WEBHOOKS_URL) that you will use must be a secure url.

###### Certificates

When you load hubot-circuit adapter, an express https server will start up on 443 port. In order for the https server to start up place the certificate files, named 'key.pem' and 'cert.pem', in the root folder of your application.
When you load hubot-circuit adapter, an express https server will start up on 443 port. In order for the https server to start up place the certificate files, named 'key.pem' and 'cert.pem', in the root folder of your application.


If you have not provided any certificates an http server will start up on 8181 port.
Expand Down
14 changes: 0 additions & 14 deletions bitbucket-pipelines.yml

This file was deleted.

12 changes: 10 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,16 @@
"test": "coffeelint src/circuit.coffee && mocha -c --full-trace --compilers coffee:coffee-script/register --require coffee-coverage/register-istanbul --reporter spec test/*.coffee && istanbul report text-summary lcov",
"coveralls": "istanbul report text-summary lcov && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
},
"author": "",
"license": "ISC",
"author": "Unify Inc.",
"license": "Apache-2.0",
"contributors": [
"Bettina Topali <despoina.topali@unify.com>",
"Eleni Dimitropoulou <eleni.dimitropoulou@unify.com>",
"Theodoros Psychogios <theodoros.psychogios@unify.com>"
],
"engines": {
"node": ">= 4.8.4"
},
"dependencies": {
"body-parser": "^1.17.1",
"express": "^4.15.2",
Expand Down

0 comments on commit c26563f

Please sign in to comment.