Merge branch 'master' into vs/refactor

JuliaIO · Aug 14, 2023 · 1956c69 · 1956c69
2 parents 05d4a98 + 3ad2d84
commit 1956c69
Showing 1 changed file with 24 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,8 @@ This module provides a wrapper for the gzip related functions of
 unencumbered, lossless data-compression library. These functions
 allow the reading and writing of gzip files.
 
+Documentation: https://gzipjl.readthedocs.org/en/latest/
+
 Usage
 -----
 
@@ -29,6 +31,25 @@ write(fh, s)
 close(fh)
 ```
 
-
-See the [documentation](https://gzipjl.readthedocs.org/en/latest/)
-for additional information.
+## Notes
+
+-   This interface is only for gzipped files, not the streaming zlib compression interface. Internally, it depends on/uses the streaming interface, but the gzip related functions are higher level functions pertaining to gzip files only.                                            
+-   `GZipStream` is an implementation of `IO` and can be used virtually anywhere `IO` is used.
+-   This implementation mimics the `IOStream` implementation, and should be a drop-in replacement for `IOStream`, with some caveats:
+    -   `seekend` and `truncate` are not available
+    -   `readuntil` is available, but is not very efficient. (But `readline` works fine.)                        
+
+In addition to `open`, `gzopen`, and `gzdopen`, the following `IO`/`IOStream` functions are supported:                 
+-   `close()`                                                                                                    
+-   `flush()`                                                                                                    
+-   `seek()`                                                                                                     
+-   `skip()`                                                                                                     
+-   `position()`                                                                                                 
+-   `eof()`                                                                                                      
+-   `read()`                                                                                                     
+-   `readuntil()`                                                                                                
+-   `readline()`                                                                                                 
+-   `write()`                                                                                                    
+-   `peek()`                                                                                                     
+
+Due to limitations in `zlib`, `seekend` and `truncate` are not available.