Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
martin-sucha committed Aug 13, 2020
1 parent f3b4598 commit bc5258f
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@
zipserve
========

Package zipserve provides support for serving zip archives over HTTP,
allowing range queries and resumable downloads. To be able to do that, it requires
to know CRC32 of the uncompressed data, compressed and uncompressed size of files in advance, which must be
supplied by the user. The actual file data is fetched on demand from user-provided
ReaderAt allowing it to be fetched remotely.
Package zipserve implements serving virtual zip archives over HTTP,
with support for range queries and resumable downloads. Zipserve keeps only the
archive headers in memory (similar to archive/zip when streaming).
The actual file data is fetched on demand from user-provided ReaderAt,
so the file data can be fetched from a remote location.
Zipserve needs to know CRC32 of the uncompressed data, compressed and uncompressed size of files in advance,
which must be supplied by the user.

Differences to archive/zip:
Differences to archive/zip
--------------------------

- Deprecated FileHeader fields present in archive/zip (`CompressedSize`, `UncompressedSize`, `ModifiedTime`,
`ModifiedDate`) were removed in this package. This means the extended time information (unix timestamp) is always
Expand All @@ -23,6 +26,12 @@ Documentation
- Package documentation: https://godoc.org/github.com/martin-sucha/zipserve
- ZIP format: https://support.pkware.com/display/PKZIP/APPNOTE

Status of the project
---------------------

The module is stable and supports writing almost everything as archive/zip (see `Differences to archive/zip` above),
so there aren't many commits. I update the module when a new version of Go is released or on request.

License
-------

Expand Down

0 comments on commit bc5258f

Please sign in to comment.