-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6345 from ipfs/fix/5254
doc: remove out of date documentation
- Loading branch information
Showing
1 changed file
with
0 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,4 @@ | ||
/* | ||
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 |