mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-26 13:29:12 -05:00
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
|
Compression and Archive Extensions
|
||
|
==================================
|
||
|
|
||
|
[![Go Walker](http://gowalker.org/api/v1/badge)](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.
|