summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4effe3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+#ipfs-archive-manager
+
+A tool that manages IPFS archives on your behalf. This updates your archive's IPNS name as well, for consistant updating.
+
+Depends on IPFS, of course.
+
+Usage:
+`ipfs-archive-manager videos beach beachvid1.mp4`
+Archives `beachvid1.mp4` to a subfolder in `/videos` called `beach`
+so, in full, IPFS will store the video as `/videos/beach/beachvid1.mp4`
+
+`ipfs-archive-manager memes ./funny.mp4 funny.mp4`
+This will archive funny.mp4 to `/memes/funny.mp4`.