From 355962fa13094ad639f3dfe69b9eaab862d41981 Mon Sep 17 00:00:00 2001 From: Roy Marmelstein Date: Mon, 19 Sep 2016 08:48:43 +0200 Subject: [PATCH] README update --- README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bf65a98..7b9dcb1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ![Zip - Zip and unzip files in Swift](https://cloud.githubusercontent.com/assets/889949/12374908/252373d0-bcac-11e5-8ece-6933aeae8222.png) [![Build Status](https://travis-ci.org/marmelroy/Zip.svg?branch=master)](https://travis-ci.org/marmelroy/Zip) [![Version](http://img.shields.io/cocoapods/v/Zip.svg)](http://cocoapods.org/?q=Zip) +[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) # Zip A Swift framework for zipping and unzipping files. Simple and quick to use. Built on top of [minizip](https://github.com/nmoinvaz/minizip). @@ -18,7 +19,7 @@ import Zip The easiest way to use Zip is through quick functions. Both take local file paths as NSURLs, throw if an error is encountered and return an NSURL to the destination if successful. ```swift do { - let filePath = NSBundle.mainBundle().URLForResource("file", withExtension: "zip")! + let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")! let unzipDirectory = try Zip.quickUnzipFile(filePath) // Unzip let zipFilePath = try Zip.quickZipFiles([filePath], fileName: "archive") // Zip } @@ -32,14 +33,13 @@ catch { For more advanced usage, Zip has functions that let you set custom destination paths, work with password protected zips and use a progress handling closure. These functions throw if there is an error but don't return. ```swift do { - let filePath = NSBundle.mainBundle().URLForResource("file", withExtension: "zip")! - let documentsDirectory = NSFileManager.defaultManager().URLsForDirectory(.DocumentDirectory, inDomains: .UserDomainMask)[0] as NSURL - + let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")! + let documentsDirectory = FileManager.default.urls(for:.documentDirectory, in: .userDomainMask)[0] try Zip.unzipFile(filePath, destination: documentsDirectory, overwrite: true, password: "password", progress: { (progress) -> () in print(progress) }) // Unzip - let zipFilePath = documentsFolder.URLByAppendingPathComponent("archive.zip") + let zipFilePath = documentsFolder.appendingPathComponent("archive.zip") try Zip.zipFiles([filePath], zipFilePath: zipFilePath, password: "password", progress: { (progress) -> () in print(progress) }) //Zip @@ -60,5 +60,22 @@ Zip.addCustomFileExtension("file-extension-here") ### Setting up with [CocoaPods](http://cocoapods.org/?q=Zip) ```ruby source 'https://github.com/CocoaPods/Specs.git' -pod 'Zip', '~> 0.5', :submodules => true +pod 'Zip', '~> 0.6' +``` + +### 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. + +You can install Carthage with [Homebrew](http://brew.sh/) using the following command: + +```bash +$ brew update +$ brew install carthage +``` + +To integrate Zip into your Xcode project using Carthage, specify it in your `Cartfile`: + +```ogdl +github "marmelroy/Zip" ``` -- 2.26.2