Permalink
Browse files

Added a README

  • Loading branch information...
1 parent ade23e5 commit 8b88eb7611da2ecd5e08c30da76c8349166a5356 nathan spindel committed Apr 16, 2012
Showing with 24 additions and 0 deletions.
  1. +24 −0 README
View
@@ -0,0 +1,24 @@
+# JIRAFoundation #
+
+## Intro ##
+
+JIRAFoundation is a Foundation framework that does network communication with the JIRA REST API and provides a model object layer. It's built on RESTKit and uses ARC.
+
+It's definitely a work in progress; right now it can only get projects and issues, but the foundation is there to build upon.
+
+## Example Usage ##
+
+ JKAPIController *jiraAPIController = [[JKAPIController alloc] init];
+ jiraAPIController.session = [[JKSession alloc] initWithBaseURL:[NSURL URLWithString:@"https://example.com/jira"] userName:@"USER" password:@"PASSWORD"];
+
+ [jiraAPIController loadAllIssuesAssignedToMeWithCompletionHandler:^(NSError *error, NSArray *resources) {
+ NSLog(@"loaded issues: %@", resources);
+ }];
+
+ [jiraAPIController loadAllProjectsWithCompletionHandler:^(NSError *error, NSArray *resources) {
+ NSLog(@"loaded projects: %@", resources);
+ }];
+
+ [jiraAPIController loadIssueWithIdentifier:@"12345" completionHandler:^(NSError *error, NSArray *resources) {
+ NSLog(@"loaded issue: %@", resources);
+ }];

0 comments on commit 8b88eb7

Please sign in to comment.