Adding readme + comments

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "xpress_lz77"
-version = "0.1.0"
+version = "1.0.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

README.md

@@ -0,0 +1,20 @@
+# xpress lz77 decompression algorithms
+xpress LZ77 Plain and xpress LZ77+Huffman Decompression algorithms : A rust implementation using pyo3.
+
+# Context
+Both algorithms are used by microsoft and can help with digital forensics:
+
+- Windows 1.X prefetch files
+- Windows Hibernation
+
+The use of pyo3 make the creation of a python package possible for integration in python3 tools where decompression performances are required.
+
+## Use cases
+
+- https://www.forensicxlab.com/posts/prefetch/
+- https://www.forensicxlab.com/posts/hibernation/
+
+
+# References
+
+- Pseudo code algorithm : https://winprotocoldoc.blob.core.windows.net/productionwindowsarchives/MS-XCA/%5bMS-XCA%5d.pdf [Section 2.2]

src/xpress_lz77_huffman.rs

@@ -1,3 +1,6 @@
+// Huffman+LZ77 Decompression Algorithm
+// Reference: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-xca/a8b7cb0a-92a6-4187-a23b-5e14273b96f8
+
 use std::cell::RefCell;
 use std::fmt;
 use std::io::Error;