README.md 1.88 KB

Build Status

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 the latest branch but marked to compile for Swift 2.3.

CocoaPods

pod install SSZipArchive

Carthage

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

// Create
[SSZipArchive createZipFileAtPath: zipPath withContentsOfDirectory: sampleDataPath];

// Unzip
[SSZipArchive unzipFileAtPath:zipPath toDestination: unzipPath];

Swift

// Create
SSZipArchive.createZipFileAtPath(zipPath, withContentsOfDirectory: sampleDataPath)

// Unzip
SSZipArchive.unzipFileAtPath(zipPath, toDestination: unzipPath)

License

SSZipArchive is protected under the MIT license and our slightly modified version of Minizip 1.1 is licensed under the Zlib license.

Acknowledgments

Big thanks to aish for creating ZipArchive. The project that inspired SSZipArchive. Thank you @randomsequence for implementing the creation support tech and to @johnezang for all his amazing help along the way.