add example and update README

This commit is contained in:
you21979
2017-07-10 19:06:33 +09:00
parent 0aba4d0e55
commit 5dcafe026e
2 changed files with 31 additions and 4 deletions

View File

@@ -8,9 +8,22 @@ Electrum Protocol Client for Node.js
npm i electrum-client
```
## spec
## usage
* ○ TCP stratum
* x SSL stratum
* ○ subscribe
```
const ElectrumCli = require('electrum-client')
const main = async () => {
const ecl = new ElectrumCli(995, 'btc.smsys.me', 'tls') // tcp or tls
await ecl.connect() // connect(promise)
ecl.subscribe.on('blockchain.headers.subscribe', (v) => console.log(v)) // subscribe message(EventEmitter)
try{
const ver = await ecl.server_version("2.7.11", "1.0") // json-rpc(promise)
console.log(ver)
}catch(e){
console.log(e)
}
await ecl.close() // disconnect(promise)
}
main()
```

14
example/simple.js Normal file
View File

@@ -0,0 +1,14 @@
const ElectrumCli = require('..')
const main = async () => {
const ecl = new ElectrumCli(995, 'btc.smsys.me', 'tls')
await ecl.connect()
try{
const ver = await ecl.server_version("2.7.11", "1.0")
console.log(ver)
}catch(e){
console.log(e)
}
await ecl.close()
}
main()