Add: squish docs

This commit is contained in:
kayos@tcp.direct 2022-02-04 00:05:33 -08:00
parent 3769c54b38
commit 65b7d32841
Signed by: kayos
GPG Key ID: 4B841471B4BEE979

43
squish/README.md Normal file

@ -0,0 +1,43 @@
# squish
--
import "git.tcp.direct/kayos/common/squish"
## Usage
#### func B64d
```go
func B64d(str string) (data []byte)
```
B64d decodes the given string into the original slice of bytes. Do note that
this is for non critical tasks, it has no error handling for purposes of clean
code.
#### func B64e
```go
func B64e(cytes []byte) (data string)
```
B64e encodes the given slice of bytes into base64 standard encoding.
#### func Gunzip
```go
func Gunzip(data []byte) ([]byte, error)
```
Gunzip decompresses a gzip compressed slice of bytes.
#### func Gzip
```go
func Gzip(data []byte) ([]byte, error)
```
Gzip compresses as slice of bytes using gzip compression.
#### func UnpackStr
```go
func UnpackStr(encoded string) string
```
UnpackStr UNsafely unpacks (usually banners) that have been base64'd and then
gzip'd.