summaryrefslogtreecommitdiffstats
path: root/network/ipfs-pack/README
diff options
context:
space:
mode:
Diffstat (limited to 'network/ipfs-pack/README')
-rw-r--r--network/ipfs-pack/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/network/ipfs-pack/README b/network/ipfs-pack/README
new file mode 100644
index 0000000000..e3a01d7f10
--- /dev/null
+++ b/network/ipfs-pack/README
@@ -0,0 +1,24 @@
+IPFS (InterPlanetary File System) is a hypermedia p2p protocol suite
+that has HTTP gateway built in. It can be used to store any kind of
+immutable datasets, organized in files, directories, and commits.
+
+For more information, check out go-ipfs (which is central package for
+IPFS, but not a direct dependency for ipfs-pack).
+
+ipfs-pack is a tool and library to work with ipfs and large
+collections of data in UNIX/POSIX filesystems.
+
+It identifies singular collections or bundles of data (the pack).
+
+It creates a light-weight cryptographically secure manifest that
+preserves the integrity of the collection over time, and travels
+with the data (PackManifest).
+
+It helps use ipfs in a mode that references the filesystem files
+directly and avoids duplicating data (filestore).
+
+It carries a standard dataset metadata file to capture and present
+information about the dataset (data-package.json).
+
+It helps verify the authenticity of data through a file carrying
+cryptographic signatures (PackAuth).