coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-03-06 00:38:08 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #6345 from ipfs/fix/5254

Browse Source 
doc: remove out of date documentation
This commit is contained in:
Steven Allen 2019-05-17 10:53:55 -07:00 committed by GitHub
commit 14ff3f99c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc.go
View File

@ -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