README updated

This commit is contained in:
Matias Alejo Garcia 2014-01-19 12:39:34 -03:00
parent 10972fd8dd
commit 73a1d64e01
1 changed files with 22 additions and 0 deletions

View File

@ -128,6 +128,12 @@ A REST API is provided at /api. The entry points are:
/api/txs/?address=ADDR
/api/txs/?address=mmhmMNfBiZZ37g1tgg2t8DDbNoEdqKVxAL
### Sync status
```
/api/sync
```
## Web Socket API
The web socket API is served using [socket.io](http://socket.io) at:
```
@ -160,6 +166,22 @@ Sample output:
}
```
'sync': every 1% increment on the sync task, this event will be triggered.
Sample output:
```
{
blocksToSync: 164141,
syncedBlocks: 475,
upToExisting: true,
scanningBackward: true,
isEndGenesis: true,
end: "000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943",
isStartGenesis: false,
start: "000000009f929800556a8f3cfdbe57c187f2f679e351b12f7011bfc276c41b6d"
}
```
## Troubleshooting
If you did not get all library during grunt command, please use the follow command: