66 lines
2.0 KiB
Markdown
66 lines
2.0 KiB
Markdown
|
|
[](https://travis-ci.org/ZipArchive/ZipArchive)
|
|
|
|
# SSZipArchive
|
|
|
|
ZipArchive is a simple utility class for zipping and unzipping files on iOS and Mac.
|
|
|
|
- Unzip zip files;
|
|
- Unzip password protected zip files;
|
|
- Create new zip files;
|
|
- Append to existing zip files;
|
|
- Zip files;
|
|
- Zip-up NSData instances. (with a filename)
|
|
|
|
## Installation and Setup
|
|
|
|
*The main release branch is configured to support Objective C and Swift 3. There is a 'swift23' branch which is a tied to a older 1.x release and will not be upgraded. Xcode 8.3+ removes support for Swift 2.3*
|
|
|
|
### CocoaPods
|
|
In your Podfile:
|
|
`pod 'SSZipArchive'`
|
|
|
|
### Carthage
|
|
In your Cartfile:
|
|
`github "ZipArchive/ZipArchive"`
|
|
|
|
### Manual
|
|
|
|
1. Add the `SSZipArchive` and `minizip` folders to your project.
|
|
2. Add the `libz` library to your target
|
|
|
|
SSZipArchive requires ARC.
|
|
|
|
## Usage
|
|
|
|
### Objective-C
|
|
|
|
```objective-c
|
|
// Create
|
|
[SSZipArchive createZipFileAtPath: zipPath withContentsOfDirectory: sampleDataPath];
|
|
|
|
// Unzip
|
|
[SSZipArchive unzipFileAtPath:zipPath toDestination: unzipPath];
|
|
```
|
|
|
|
### Swift
|
|
|
|
```swift
|
|
// Create
|
|
SSZipArchive.createZipFileAtPath(zipPath, withContentsOfDirectory: sampleDataPath)
|
|
|
|
// Unzip
|
|
SSZipArchive.unzipFileAtPath(zipPath, toDestination: unzipPath)
|
|
```
|
|
|
|
## License
|
|
|
|
SSZipArchive is protected under the [MIT license](https://github.com/samsoffes/ssziparchive/raw/master/LICENSE) and our slightly modified version of [Minizip](https://github.com/nmoinvaz/minizip) 1.1 is licensed under the [Zlib license](http://www.zlib.net/zlib_license.html).
|
|
|
|
## Acknowledgments
|
|
|
|
* Big thanks to [aish](http://code.google.com/p/ziparchive) for creating [ZipArchive](http://code.google.com/p/ziparchive). The project that inspired SSZipArchive.
|
|
* Thank you [@soffes](https://github.com/soffes) for the actual name of SSZipArchive.
|
|
* Thank you [@randomsequence](https://github.com/randomsequence) for implementing the creation support tech.
|
|
* Thank you [@johnezang](https://github.com/johnezang) for all his amazing help along the way.
|