0.5.10

guzba · Jun 2, 2021 · 0148bc5 · 0148bc5
1 parent 8d9c01e
commit 0148bc5
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -268,6 +268,13 @@ Opens the tarball file located at path and reads its contents into tarball.conte
 proc open(tarball: Tarball; path: string) {.raises: [IOError, ZippyError, ZippyError], tags: [ReadIOEffect].}
 ```
 
+## **proc** open
+
+Opens the tarball from a stream and reads its contents into tarball.contents (clears any existing tarball.contents entries).
+
+```nim
+proc open(tarball: Tarball; stream: Stream) {.raises: [IOError, ZippyError, OSError], tags: [ReadIOEffect].}
+
 ## **proc** writeTarball
 
 Writes tarball.contents to a tarball file at path. Uses the path's file extension to determine the tarball format. Supports .tar, .tar.gz, .taz and .tgz file extensions.
@@ -357,10 +364,10 @@ proc open(archive: ZipArchive; path: string) {.raises: [IOError, ZippyError, Zip
 
 ## **proc** open
 
-Opens the zip archive from a stream (in-memory) and reads its contents into archive.contents (clears any existing archive.contents entries).
+Opens the zip archive from a stream and reads its contents into archive.contents (clears any existing archive.contents entries).
 
 ```nim
-proc open(archive: ZipArchive; stream: StringStream) {.raises: [IOError, ZippyError, OSError], tags: [ReadIOEffect].}
+proc open(archive: ZipArchive; stream: Stream) {.raises: [IOError, ZippyError, OSError], tags: [ReadIOEffect].}
 ```
 
 ## **proc** writeZipArchive

diff --git a/zippy.nimble b/zippy.nimble
@@ -1,4 +1,4 @@
-version       = "0.5.9"
+version       = "0.5.10"
 author        = "Ryan Oldenburg"
 description   = "Pure Nim implementation of deflate, zlib, gzip and zip."
 license       = "MIT"