Added readme, tidying up files

map17018 · Apr 22, 2022 · a7d7693 · a7d7693
1 parent 7dcc774
commit a7d7693
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 64 deletions.
diff --git a/CTng/GZip/GZipComp.go b/CTng/GZip/GZipComp.go
diff --git a/CTng/GZip/Readme.md b/CTng/GZip/Readme.md
@@ -0,0 +1,16 @@
+# GZIP Implementation
+
+## Contents: 
+- `Decode.go`: defines the decode and encode functions 
+- `GZipbyte.go`: contains the compress function 
+- `GZipDecomp.go`: contains the decompression function
+
+## Decode.go:
+- Decode takes in bytes, decompresses them, then returns the decoded string if successful, error if not
+- Encode takes in bytes, compresses them, then returns an encoded string if successful, error if not 
+
+## GZipbyte.go: 
+- When given a bytes it will compress them and return compressed bytes
+
+## GZipDecomp.go:
+- Decompresses the the compressed bytes to readable data