A generator for go-ipfs API endpoints documentation.
In order to build this project, you need to download go-ipfs and install its gx dependencies:
> go get github.com/ipfs/go-ipfs
> cd $GOPATH/src/github.com/ipfs/go-ipfs
> make deps
Then you can:
> go install github.com/ipfs/http-api-docs/http-api-docs
Or alternatively checkout this repository and run:
> make install
After installing you can run:
> http-api-docs
This should spit out a Markdown document. This is exactly the api.md documentation at https://github.com/ipfs/website/blob/master/content/pages/docs/api.md , so you can redirect the output to just overwrite that file.
This project is captained by @hsanjuan.
PRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.
MIT © Hector Sanjuan