Skip to content

Commit

Permalink
Merge pull request #6345 from ipfs/fix/5254
Browse files Browse the repository at this point in the history
doc: remove out of date documentation
  • Loading branch information
Stebalien authored May 17, 2019
2 parents 9284cb2 + 64dbd02 commit 14ff3f9
Showing 1 changed file with 0 additions and 23 deletions.
23 changes: 0 additions & 23 deletions doc.go
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

0 comments on commit 14ff3f9

Please sign in to comment.