Usage + APIs

[jbenet]

• provide CLI overview
• provide Golang API overview btc
• provide JSON API overview
• mention node-ipfs JS bindings

[jbenet]

I'd like to command and API docs. We have ipfs commands which outputs the list. we can probably also trivially generate one page with all the help texts (i've done this before) separated by markdown headers, with a markdown TOC at the head. The API is a bit trickier, as it involves translating our commands lib into nice, standard API text. Definitely doable.

Here are some nice api docs to emulate:

• https://stripe.com/docs/api#transfers
• https://developer.github.com/v3/
• https://coreos.com/docs/
• http://backbonejs.org/docs/backbone.html
• http://twitter.github.io/hogan.js/
• https://github.com/PharkMillups/beautiful-docs

Maybe we can generate much of the markdown needed for slate: https://github.com/tripit/slate -- though we'd still need lots of examples.

cc @mappum

[daviddias]

API's are now all being documented at https://github.com/ipfs/api 🎉🎉🎉

[daviddias]

Update:

• https://github.com/ipfs/api
• Add Group add ipfs-inactive/http-api-spec#17
• WIP: IPFS API (core+http+cli) specs#65