kredits/hubot-kredits
9
0
Fork 0
Code Issues 8 Pull Requests Releases 9 Activity

Add README/documentation #19

Merged
raucao merged 3 commits from docs/9-readme into master 2018-04-22 14:36:54 +00:00
Conversation 0 Commits 3 Files Changed 3 +9 -4
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit b4229c7879 - Show all commits

11
README.md
View File

@ -6,6 +6,11 @@ chatbots. The bot will watch for project-related things happening on the
Internet and automatically create proposals for issuing kredits for project
contributions.
## Setup
You will need an Ethereum wallet for your bot, so it can interact with the
Ethereum smart contracts. `npm run create-wallet` will do the job for you.
## Configuration
As usual in Hubot, you can add all config as environment variables.
@ -14,10 +19,10 @@ As usual in Hubot, you can add all config as environment variables.
| --- | --- |
| `KREDITS_WEBHOOK_TOKEN` | A string for building your secret webhook URLs |
| `KREDITS_ROOM` | The bot will talk to you in this room |
| `KREDITS_WALLET_PATH` | Path to an Etherum wallet JSON file |
| `KREDITS_WALLET_PATH` | Path to an Etherum wallet JSON file (default: `./wallet.json`) |
| `KREDITS_WALLET_PASSWORD` | Wallet password |
| `KREDITS_PROVIDER_URL` | Ethereum JSON-RPC URL (default `http://localhost:7545`) |
| `KREDITS_NETWORK_ID` | The ethereum network ID to use (default 100 = local) |
| `KREDITS_PROVIDER_URL` | Ethereum JSON-RPC URL (default: `http://localhost:7545`) |
| `KREDITS_NETWORK_ID` | The ethereum network ID to use (default: 100 = local) |
## Integrations

2
package.json
View File

@ -7,7 +7,7 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"bin": {
"kredits-wallet-create": "scripts/create-wallet.js"
"create-wallet": "scripts/create-wallet.js"
},
"dependencies": {
"ethers": "^3.0.15",