Skip to content

Commit

Permalink
Added example usage and documentation link to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
abbeycode committed Dec 9, 2014
1 parent 5e74aea commit 103b2f8
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,24 @@ There is a main project, with unit tests, and a basic iOS example project, which
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.


# Example Usage

```Objective-C
URKArchive *archive = [URKArchive rarArchiveAtPath:@"An Archive.rar"];

NSError *error = nil;

NSArray *filesInArchive = [archive listFiles:&error];
BOOL extractFilesSuccessful = [archive extractFilesTo:extractURL.path
overWrite:NO
error:&error];
NSData *extractedData = [archive extractDataFromFile:@"a file in the archive.jpg"
error:&error];
```
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).
# 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).
Expand All @@ -22,6 +40,10 @@ I've included a sample [`podfile`](Example/Podfile) in the Example directory alo
To open in Xcode, use the [UnrarKit.xcworkspace](UnrarKit.xcworkspace) file, which includes the other projects.
## Documentation
Full documentation for the project is available on [CocoaDocs](http://cocoadocs.org/docsets/UnrarKit).
# Credits
* Dov Frankel ([email protected])
Expand Down

0 comments on commit 103b2f8

Please sign in to comment.