certusone
/
tendermint
mirror of https://github.com/certusone/tendermint.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
tendermint/rpc/core
History
Ethan Buchman f2349b1092 Merge pull request #526 from tendermint/feature/rpc-docs 
RPC docs
 		2017-08-25 18:10:21 -04:00
..
types First crack it providing fast-sync endpoint 2017-07-10 19:30:54 +02:00
README.md rpc: typo fixes 2017-08-16 15:18:55 -04:00
abci.go wrote docs for rpc methods [ci skip] 2017-08-16 15:17:08 -04:00
blocks.go wrote docs for rpc methods [ci skip] 2017-08-16 15:17:08 -04:00
consensus.go wrote docs for rpc methods [ci skip] 2017-08-16 15:17:08 -04:00
dev.go remove viper from rpc except test 2017-05-04 22:43:55 -04:00
doc.go rpc: typo fixes 2017-08-16 15:18:55 -04:00
doc_template.txt generate md for Slate 2017-08-16 15:17:08 -04:00
events.go rpc: typo fixes 2017-08-16 15:18:55 -04:00
mempool.go wrote docs for rpc methods [ci skip] 2017-08-16 15:17:08 -04:00
net.go wrote docs for rpc methods [ci skip] 2017-08-16 15:17:08 -04:00
pipe.go comments 2017-08-09 23:51:09 -04:00
routes.go [rpc] dont enable unsafe by default; limit /blockchain_info to 20 blocks 2017-05-24 11:31:31 -04:00
status.go Merge pull request #526 from tendermint/feature/rpc-docs 2017-08-25 18:10:21 -04:00
tx.go rpc: typo fixes 2017-08-16 15:18:55 -04:00
version.go rpc -> rpc/lib and rpc/tendermint -> rpc 2017-04-26 19:57:33 -04:00

README.md

Tendermint RPC

Generate markdown for Slate

We are using Slate to power our RPC documentation. If you are changing a comment, make sure to copy the resulting changes to the slate repo and make a PR there as well. For generating markdown use:

go get github.com/melekes/godoc2md

godoc2md -template rpc/core/doc_template.txt github.com/tendermint/tendermint/rpc/core | grep -v -e "pipe.go" -e "routes.go" -e "dev.go" | sed 's$/src/target$https://github.com/tendermint/tendermint/tree/master/rpc/core$'