From 8e5c6da5dcf16ca9106d5affeca42407c7e28b46 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Tue, 5 Jul 2016 16:09:34 +0100 Subject: [PATCH] Fill out Usage section While I could list all of the available methods, I think that the GoDocs already do this fairly well and I would be duplicating data. However, a tracking issue with all of the methods that are needed would be ace. Shall I set one of those up? I also point to the spec here. If someone points me to a Go package with a good Usage and API section, I am happy to fill this out more; however, I am not sure how else to best go forth with filling this section out. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 18fe66eb2..e2ba8921a 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This will download the source into `$GOPATH/src/github.com/ipfs/go-ipfs-api`. ## Usage -... +See [the godocs](https://godoc.org/github.com/ipfs/go-ipfs-api) for details on available methods. This should match the specs at [ipfs/specs](https://github.com/ipfs/specs/tree/master/api); however, there are still some methods which are not accounted for. If you would like to add any of them, see the contribute section below. ## Contribute