update readme and changelog

KillingSpark · Dec 13, 2024 · 99dee17 · 99dee17
1 parent 1237041
commit 99dee17
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -33,4 +33,4 @@ This document records the changes made between versions, starting with version 0
 * Added convenience functions to FrameDecoder to decode multiple frames from a buffer (https://github.com/philipc)
 
 # After 0.7.3
-
+* Add initial compression support
diff --git a/Readme.md b/Readme.md
@@ -9,8 +9,7 @@
 A pure Rust implementation of the Zstandard compression algorithm, as defined in [this document](https://github.com/facebook/zstd/blob/dev/doc/zstd_compression_format.md).
 
 This crate contains a fully operational implementation of the decompression portion of the standard.
-
-*Work has started on a compressor, but it has not reached a point where the compressor provides any real function.* (CONTRIBUTORS WELCOME)
+It also provides a compressor which is usable, but it does not yet reach the speed, ratio or configurability of the original zstd library.
 
 This crate is currently actively maintained.
 
@@ -19,9 +18,14 @@ This crate is currently actively maintained.
 Feature complete on the decoder side. In terms of speed it is still behind the original C implementation which has a rust binding located [here](https://github.com/gyscos/zstd-rs).
 
 On the compression side:
-- [x] Support for generating raw, uncompressed frames
-- [ ] Support for generating RLE compressed blocks
-- [ ] Support for generating compressed blocks at any compression level
+- Support for generating compressed blocks at any compression level
+  - [x] Uncompressed
+  - [x] Fastest (roughly level 1)
+  - [ ] Default (roughly level 3)
+  - [ ] Better (roughly level 7)
+  - [ ] Best (roughly level 11)
+- [ ] Checksums
+- [ ] Dictionaries
 
 ## Speed
 

diff --git a/src/encoding/frame_encoder.rs b/src/encoding/frame_encoder.rs
@@ -21,8 +21,6 @@ pub enum CompressionLevel {
     /// it in a Zstandard frame.
     Uncompressed,
     /// This level is roughly equivalent to Zstd compression level 1
-    ///
-    /// UNIMPLEMENTED
     Fastest,
     /// This level is roughly equivalent to Zstd level 3,
     /// or the one used by the official compressor when no level
Original file line number	Diff line number	Diff line change
Expand Up		@@ -33,4 +33,4 @@ This document records the changes made between versions, starting with version 0
		* Added convenience functions to FrameDecoder to decode multiple frames from a buffer (https://github.com/philipc)

		# After 0.7.3

		* Add initial compression support