Permalink
Browse files

Update Documentation

  • Loading branch information...
1 parent f1a24cd commit 132bd7b079e6348d900a90f7b801dc0dc97df052 @collindonnell committed Oct 18, 2012
Showing with 7 additions and 7 deletions.
  1. +7 −7 README.md
View
@@ -1,18 +1,18 @@
# ALBPinbookActivity
-ALBPinbookActivity is a UIActivity subclass which allows developers to send bookmark information to Pinbook so that it can be presented as an option in a UIActivityViewController whenever a URL is shared, and added to the users Pinboard account.
+`ALBPinbookActivity` is a `UIActivity` subclass which allows developers to send bookmark information to [Pinbook](http://albinadevelopment.com/page3) for adding to a users [Pinboard](http://pinboard.in) account by showing a “Send to Pinbook” option in a `UIActivityViewController` sharing sheet.
## Adding to a Project
Add the following four files to your project:
-* ALBPinbookActivity.h
-* ALBPinbookActivity.m
-* ALBPinbookActivityMask.png
-* ALBPinbookActivityMask@2x.png
+* `ALBPinbookActivity.h`
+* `ALBPinbookActivity.m`
+* `ALBPinbookActivityMask.png`
+* `ALBPinbookActivityMask@2x.png`
## Use
-Just create a new ALBPinbookActivity object and use it with a UIActivityViewController. Pinbook will appear as an option only if the user has it installed on their device.
+Just create a new `ALBPinbookActivity` object and use it as a application activity when instantiating a `UIActivityViewController`. Pinbook will appear as an option only if the user has installed it on their device.
-Optionally, set the `bookmarkParameters` property using an NSDictionary to pre-fill Pinbook’s fields with any information you like, as shown in the following example:
+Optionally, set the `bookmarkParameters` property with an NSDictionary to pre-fill Pinbook’s fields with any information you like, as shown in the following example:
ALBPinbookActivity *activity = [[ALBPinbookActivity alloc] init];
activity.bookmarkParameters = @{ALBPinbookTitleParameterKey : @"Apple", ALBPinbookTagsParameterKey : @"companies mac iphone", ALBPinbookDescriptionParameterKey : @"They make nice things.", ALBPinbookPrivateParameterKey : @(YES), ALBPinbookReadLaterParameterKey : @(NO)};

0 comments on commit 132bd7b

Please sign in to comment.