diff options
Diffstat (limited to 'vendor/github.com/Unknwon/cae/README.md')
| -rw-r--r-- | vendor/github.com/Unknwon/cae/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/vendor/github.com/Unknwon/cae/README.md b/vendor/github.com/Unknwon/cae/README.md new file mode 100644 index 0000000000..e72de97205 --- /dev/null +++ b/vendor/github.com/Unknwon/cae/README.md @@ -0,0 +1,37 @@ +Compression and Archive Extensions +================================== + +[](http://gowalker.org/github.com/Unknwon/cae) + +[中文文档](README_ZH.md) + +Package cae implements PHP-like Compression and Archive Extensions. + +But this package has some modifications depends on Go-style. + +Reference: [PHP:Compression and Archive Extensions](http://www.php.net/manual/en/refs.compression.php). + +Code Convention: based on [Go Code Convention](https://github.com/Unknwon/go-code-convention). + +### Implementations + +Package `zip`([Go Walker](http://gowalker.org/github.com/Unknwon/cae/zip)) and `tz`([Go Walker](http://gowalker.org/github.com/Unknwon/cae/tz)) both enable you to transparently read or write ZIP/TAR.GZ compressed archives and the files inside them. + +- Features: + - Add file or directory from everywhere to archive, no one-to-one limitation. + - Extract part of entries, not all at once. + - Stream data directly into `io.Writer` without any file system storage. + +### Test cases and Coverage + +All subpackages use [GoConvey](http://goconvey.co/) to write test cases, and coverage is more than 80 percent. + +### Use cases + +- [Gogs](https://github.com/gogits/gogs): self hosted Git service in the Go Programming Language. +- [GoBlog](https://github.com/fuxiaohei/GoBlog): personal blogging application. +- [GoBuild](https://github.com/shxsun/gobuild/): online Go cross-platform compilation and download service. + +## License + +This project is under Apache v2 License. See the [LICENSE](LICENSE) file for the full license text.
\ No newline at end of file |