Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.78 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.78 KB

http-api-docs

standard-readme compliant Build Status

A generator for go-ipfs API endpoints documentation.

Note: This is just the generator for the docs that are available on ipfs.io, which can be found here: https://docs.ipfs.io/reference/http/api/

The original docs are written in Markdown format and are available for community contributions here: https://github.com/ipfs/ipfs-docs

Table of Contents

Install

In order to build this project, you need to first install Go, clone this repo, and finally run make install:

> git clone https://github.com/ipfs/http-api-docs "$(go env GOPATH)/src/github.com/ipfs/http-api-docs"
> cd "$(go env GOPATH)/src/github.com/ipfs/http-api-docs"
> make install

Usage

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/ipfs-docs/blob/master/docs/reference/http/api.md, so you can redirect the output to just overwrite that file.

Captain

This project is captained by @hsanjuan.

Contribute

PRs accepted.

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

License

MIT (C) Protocol Labs, Inc.