Commit 9fcc2e4f authored by Roy Marmelstein's avatar Roy Marmelstein

Readme update

parent d7c17eb2
......@@ -4,7 +4,7 @@
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
# Zip
A Swift 2 framework for zipping and unzipping files. Simple and quick to use.
A Swift framework for zipping and unzipping files. Simple and quick to use.
## Usage
......@@ -14,6 +14,20 @@ Import Zip at the top of the Swift file.
import Zip
```
## Quick functions
```swift
do {
let bb8FilePath = NSBundle.mainBundle().URLForResource("bb8", withExtension: "zip")!
try Zip().quickUnzipFile(bb8FilePath) // Unzip
try Zip().quickZipFiles([bb8FilePath], fileName: "archive") // Zip
}
catch ErrorType {
print("Something went wrong")
}
```
### Setting up with Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment