Documentation on IPFS HTTP API endpoints.
Go Makefile
Latest commit ba74067 Nov 14, 2016 @hsanjuan hsanjuan README, tests, docs, first attempt to travis
License: MIT
Signed-off-by: Hector Sanjuan <code@hector.link>

README.md

ipfs-http-api-docs

standard-readme compliant Build Status

A generator for go-ipfs API endpoints documentation.

Table of Contents

Install

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/ipfs-http-api-docs/ipfs-http-api-docs-md

Or alternatively checkout this repository and run:

> make install

Usage

After installing you can run:

> ipfs-http-api-docs-md

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.

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Hector Sanjuan