From 135403032ff9202a9b704413a6322d372cc1796e Mon Sep 17 00:00:00 2001 From: Caleb Gardner Date: Wed, 9 Dec 2020 01:45:58 -0600 Subject: [PATCH] Updated README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f993ed..bb3942c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -# squashfs +# squashfs (WIP) [![PkgGoDev](https://pkg.go.dev/badge/github.com/CalebQ42/squashfs)](https://pkg.go.dev/github.com/CalebQ42/squashfs) [![Go Report Card](https://goreportcard.com/badge/github.com/CalebQ42/squashfs)](https://goreportcard.com/report/github.com/CalebQ42/squashfs) A PURE Go library to read and write squashfs. -Currently, you can read a squashfs and extract files (folder extraction not supported. Yet). +Currently has support for reading squashfs files and extracting files and folders. Supports all compression types except LZO, but additional compression options are hit or miss. + +The only major thing missing from squashfs reading is Xattr parsing. Special thanks to https://dr-emann.github.io/squashfs/ for some VERY important information in an easy to understand format. Thanks also to [distri's squashfs library](https://github.com/distr1/distri/tree/master/internal/squashfs) as I referenced it to figure some things out (and double check others).