status-im/gitter-bridge
2
0
Fork 0
mirror of https://github.com/status-im/gitter-bridge.git synced 2025-02-22 13:08:14 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Richard Ramos 2019-04-08 15:48:05 -04:00 committed by GitHub
parent f0d4b77df1
commit 3fa64b9121
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,2 +1,18 @@
# gitter-bridge
Gitter <-> Status Bridge
### Requirements
1. node.js
2. go-ethereum
### Configuration
1. Edit `config.js` with the details on which channels to bridge, tokens and private key. You can obtain a gitter token in https://developer.gitter.im/apps
2. Execute geth in a separate terminal session `geth` following these instructions: https://github.com/status-im/status-js-api#using-geth
### Usage
1. `npm start` or `yarn start` to start the bridge.
A tool like `nodemon` could be used to automatically restart the bridge in case an error happens.
### Pending tasks
Include `murmur` to avoid having to install geth.