iOS/Pods/SSZipArchive/README.md

   1
   2 [![Build Status](https://travis-ci.org/ZipArchive/ZipArchive.svg?branch=master)](https://travis-ci.org/ZipArchive/ZipArchive)
   3
   4 # SSZipArchive
   5
   6 ZipArchive is a simple utility class for zipping and unzipping files on iOS, macOS and tvOS.
   7
   8 - Unzip zip files;
   9 - Unzip password protected zip files;
  10 - Unzip AES encrypted zip files;
  11 - Create zip files;
  12 - Create password protected zip files;
  13 - Create AES encrypted zip files;
  14 - Choose compression level;
  15 - Append to existing zip files;
  16 - Zip-up NSData instances. (with a filename)
  17
  18 ## Installation and Setup
  19
  20 *The main release branch is configured to support Objective C and Swift 3+.*
  21
  22 SSZipArchive works on Xcode 7-9 and above, iOS 8-11 and above.
  23
  24 ### CocoaPods
  25 In your Podfile:
  26 `pod 'SSZipArchive'`
  27
  28 ### Carthage
  29 In your Cartfile:
  30 `github "ZipArchive/ZipArchive"`
  31
  32 ### Manual
  33
  34 1. Add the `SSZipArchive` and `minizip` folders to your project.
  35 2. Add the `libz` library to your target
  36
  37 SSZipArchive requires ARC.
  38
  39 ## Usage
  40
  41 ### Objective-C
  42
  43 ```objective-c
  44 // Create
  45 [SSZipArchive createZipFileAtPath:zipPath withContentsOfDirectory:sampleDataPath];
  46
  47 // Unzip
  48 [SSZipArchive unzipFileAtPath:zipPath toDestination:unzipPath];
  49 ```
  50
  51 ### Swift
  52
  53 ```swift
  54 // Create
  55 SSZipArchive.createZipFileAtPath(zipPath, withContentsOfDirectory: sampleDataPath)
  56
  57 // Unzip
  58 SSZipArchive.unzipFileAtPath(zipPath, toDestination: unzipPath)
  59 ```
  60
  61 ## License
  62
  63 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.2 is licensed under the [Zlib license](http://www.zlib.net/zlib_license.html).
  64
  65 ## Acknowledgments
  66
  67 * Big thanks to [aish](http://code.google.com/p/ziparchive) for creating [ZipArchive](http://code.google.com/p/ziparchive). The project that inspired SSZipArchive.
  68 * Thank you [@soffes](https://github.com/soffes) for the actual name of SSZipArchive.
  69 * Thank you [@randomsequence](https://github.com/randomsequence) for implementing the creation support tech.
  70 * Thank you [@johnezang](https://github.com/johnezang) for all his amazing help along the way.