-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
27 lines (22 loc) · 869 Bytes
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/*
IPFS is a global, versioned, peer-to-peer filesystem
There are sub-packages within the ipfs package for various low-level
utilities, which are in turn assembled into:
core/...:
The low-level API that gives consumers all the knobs they need,
which we try hard to keep stable.
shell/...:
The high-level API that gives consumers easy access to common
operations (e.g. create a file node from a reader without wrapping
with metadata). We work really hard to keep this stable.
Then on top of the core/... and shell/... Go APIs, we have:
cmd/...:
Command-line executables
test/...:
Integration tests, etc.
To avoid cyclic imports, imports should never pull in higher-level
APIs into a lower-level package. For example, you could import all of
core and shell from cmd/... or test/..., but you couldn't import any
of shell from core/....
*/
package ipfs