Add package overview comments to coreapi
License: MIT Signed-off-by: Rob Brackett <rob@robbrackett.com>
Rob Brackett committed
Jun 12, 2018 at 15:56 UTC
319f006386e5649816e84ae06075670ab5528803
1 file changed
+14
-1
core/coreapi/coreapi.go
+14
-1
@@ -1,3 +1,16 @@
1
+/*
2
+Package coreapi provides direct access to the core commands in IPFS. If you are
3
+embedding IPFS directly in your Go program, this package is the public
4
+interface you should use to read and write files or otherwise control IPFS.
5
+
6
+If you are running IPFS as a separate process, you should use `go-ipfs-api` to
7
+work with it via HTTP. As we finalize the interfaces here, `go-ipfs-api` will
8
+transparently adopt them so you can use the same code with either package.
9
+
10
+**NOTE: this package is experimental.** `go-ipfs` has mainly been developed
11
+as a standalone application and library-style use of this package is still new.
12
+Interfaces here aren't yet completely stable.
13
+*/
14
package coreapi
15
16
import (
@@ -49,7 +62,7 @@ func (api *CoreAPI) Key() coreiface.KeyAPI {
62
return (*KeyAPI)(api)
63
}
64
52
-//Object returns the ObjectAPI interface implementation backed by the go-ipfs node
65
+// Object returns the ObjectAPI interface implementation backed by the go-ipfs node
66
func (api *CoreAPI) Object() coreiface.ObjectAPI {
67
return (*ObjectAPI)(api)
68
}