From c8c89aaa3f5be2edebc60fc42ecc63394b79e4d1 Mon Sep 17 00:00:00 2001 From: Jeffrey Paul Date: Mon, 18 Jan 2021 23:38:36 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c18a95d..b4c2d28 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Manifest file generator and checker. Given a plain URL, there is no standard way to safely and programmatically download everything "under" that URL path. `wget -r` can traverse directory listings if they're enabled, but every server has a different format, and this does not verify cryptographic integrity of the files. -Currently, the solution that people are using are sidecar files in the format of SHASUMS checksum files, as well as a SHASUMS.asc PGP detached signature. This is not checksum-agnostic and the sidecar file is not always consistently named. +Currently, the solution that people are using are sidecar files in the format of `SHASUMS` checksum files, as well as a `SHASUMS.asc` PGP detached signature. This is not checksum-algorithm-agnostic and the sidecar file is not always consistently named. # Proposed Solution @@ -34,6 +34,13 @@ The manifest file would do several important things: * be easy to download/resume * be easy to use across protocols (given an HTTPS url, fetch manifest, then download file contents via bittorrent or ipfs) +# Non-Goals +* Manifest generation speed +* Small manifest file size (within reason) + +# Open Questions +* Should the manifest file include checksums of individual file chunks, or just for the whole assembled file? + * If so, should the chunksize be fixed or dynamic? # Tool Examples * `mfer gen` / `mfer gen .`