Skip to content

Commit

Permalink
Removed unused example podfile, updated the readme not to refer to it…
Browse files Browse the repository at this point in the history
…, and to give the podfile and cartfile lines (Issue #29)
  • Loading branch information
abbeycode committed Mar 16, 2016
1 parent 237a8d6 commit 38a14d8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 17 deletions.
7 changes: 0 additions & 7 deletions Example/Podfile

This file was deleted.

23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,23 @@

UnrarKit is here to enable Mac and iOS apps to easily work with RAR files for read-only operations. It is currently based on version 5.2.1 of the [UnRAR library](http://www.rarlab.com/rar/unrarsrc-5.2.1.tar.gz).

There is a main project, with unit tests, and a basic iOS example project, which demonstrates how to use the library.
There is a main project, with unit tests, and a basic iOS example project, which demonstrates how to use the library. To see all of these, open the main workspace file.

I'm always open to improvements, so please submit your pull requests, or [create issues](https://github.com/abbeycode/UnrarKit/issues) for someone else to implement.


# Installation

UnrarKit supports both [CocoaPods](https://cocoapods.org/) and [Carthage](https://github.com/Carthage/Carthage). CocoaPods does not support dynamic framework targets (as of v0.39.0), so in that case, please use Carthage.

Cartfile:

github "abbeycode/UnrarKit"

Podfile:

pod "UnrarKit"

# Example Usage

```Objective-C
Expand Down Expand Up @@ -79,15 +91,6 @@ BOOL success = [archive extractBufferedDataFromFile:@"a file in the archive.jpg"
}];
```
# Installation
UnrarKit is a CocoaPods project, which is the recommended way to install it. If you're not familiar with [CocoaPods](http://cocoapods.org), you can start with their [Getting Started guide](http://guides.cocoapods.org/using/getting-started.html).
I've included a sample [`podfile`](Example/Podfile) in the Example directory along with the sample project. Everything should install with the single command:
pod install
# Notes
To open in Xcode, use the [UnrarKit.xcworkspace](UnrarKit.xcworkspace) file, which includes the other projects.
Expand Down

0 comments on commit 38a14d8

Please sign in to comment.