Skip to content

Commit bc5258f

Browse files
committed
Update README
1 parent f3b4598 commit bc5258f

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@
55
zipserve
66
========
77

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

14-
Differences to archive/zip:
16+
Differences to archive/zip
17+
--------------------------
1518

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

29+
Status of the project
30+
---------------------
31+
32+
The module is stable and supports writing almost everything as archive/zip (see `Differences to archive/zip` above),
33+
so there aren't many commits. I update the module when a new version of Go is released or on request.
34+
2635
License
2736
-------
2837

0 commit comments

Comments
 (0)