Skip to content

Commit

Permalink
readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mrsteveman1 committed Jan 4, 2012
1 parent b65083d commit 6c8e0ff
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.markdown
Expand Up @@ -2,9 +2,9 @@ ProwlKit
-----------


ProwlKit is a simple Objective-C wrapper with convenience methods for working with the (Prowl)[http://prowlapp.com] API.
ProwlKit is a simple Objective-C wrapper with convenience methods for working with the [Prowl](http://prowlapp.com) API.

There is only one class, ProwlKit, and it only has one dependency: (XMLReader)[https://github.com/bcaccinolo/XML-to-NSDictionary], you'll need to download that and put it in the right spot before compiling.
There is only one class, ProwlKit, and it only has one dependency: [XMLReader](https://github.com/bcaccinolo/XML-to-NSDictionary), you'll need to download that and put it in the right spot before compiling.

The framework uses a GCD serial queue to synchronize access, so it should be thread-safe

Expand All @@ -22,8 +22,8 @@ NSErrors are optional in the following methods, just remove the error part of th


####Verify an API key

BOOL success = [prowl verifyAPIKey:@"1234567890123456789012345678901234567890" error:nil]
NSError *error;
BOOL success = [prowl verifyAPIKey:@"1234567890123456789012345678901234567890" error:&error]
if (error) {
NSLog(@"Error: %@",[error localizedDescription]);
}
Expand Down Expand Up @@ -80,4 +80,4 @@ Get the users API key (if you need this you probably know what to do with it)
//do something with apiKey
}



0 comments on commit 6c8e0ff

Please sign in to comment.