Skip to content

Commit

Permalink
doc: 完善文档
Browse files Browse the repository at this point in the history
  • Loading branch information
CC11001100 committed Dec 11, 2023
1 parent 5042b2d commit 9c84a22
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

Go中用来解压zip文件的API,优势:

- 在原生的zip.File的基础上封账了一些易用API
- 支持并发解压zip文件
- 在原生的zip.File的基础上封装了易用API,一键解压
- 支持并发解压zip文件

# 二、安装

Expand All @@ -15,7 +15,26 @@ go get -u github.com/compression-algorithm-research-lab/go-unzip

# 三、API示例

TODO
```go
package main

import "github.com/compression-algorithm-research-lab/go-unzip"

func main() {

options := unzip.NewOptions().
SetSourceZipFile("test_data/foo.zip").
SetDestinationDirectory("test_data/foo").
SetWorkerNum(100)
err := unzip.New(options).Unzip()
if err != nil {
panic(err)
}

}
```





0 comments on commit 9c84a22

Please sign in to comment.