added iOS source code

[wl-app.git] / iOS / Pods / SSZipArchive / README.md

diff --git a/iOS/Pods/SSZipArchive/README.md b/iOS/Pods/SSZipArchive/README.md
new file mode 100644 (file)
index 0000000..2736bdb
--- /dev/null
+++ b/iOS/Pods/SSZipArchive/README.md
@@ -0,0 +1,70 @@
+
+[![Build Status](https://travis-ci.org/ZipArchive/ZipArchive.svg?branch=master)](https://travis-ci.org/ZipArchive/ZipArchive)
+
+# SSZipArchive
+
+ZipArchive is a simple utility class for zipping and unzipping files on iOS, macOS and tvOS.
+
+- Unzip zip files;
+- Unzip password protected zip files;
+- Unzip AES encrypted zip files;
+- Create zip files;
+- Create password protected zip files;
+- Create AES encrypted zip files;
+- Choose compression level;
+- Append to existing 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+.*
+
+SSZipArchive works on Xcode 7-9 and above, iOS 8-11 and above.
+
+### 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.2 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.