From 9fcc2e4fcd7ae998918fe85a69fc6e9ce2e7a3fe Mon Sep 17 00:00:00 2001 From: Roy Marmelstein Date: Sun, 17 Jan 2016 00:05:43 +0100 Subject: [PATCH] Readme update --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 24c9ebc..02397b6 100644 --- a/README.md +++ b/README.md @@ -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. -- 2.26.2