Permalink
Browse files

Added License, started readme.

  • Loading branch information...
Owain R Hunt
Owain R Hunt committed Aug 5, 2010
1 parent b109e28 commit 42f38c2567d6d38e16cab40592b8fe04d45e4a4b
Showing with 86 additions and 2 deletions.
  1. +29 −0 License.rtf
  2. +53 −0 README
  3. +2 −0 UAGithubEngine.m
  4. +0 −2 UAGithubEngine_Prefix.pch
  5. +2 −0 UAGithubJSONParser.m
View
@@ -0,0 +1,29 @@
+{\rtf1\ansi\ansicpg1252\cocoartf1038\cocoasubrtf320
+{\fonttbl\f0\fswiss\fcharset0 Helvetica;}
+{\colortbl;\red255\green255\blue255;}
+\paperw11905\paperh16837\margl1440\margr1440\vieww20460\viewh13960\viewkind0
+\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\ql\qnatural\pardirnatural
+
+\f0\b\fs24 \cf0 UAGithubEngine License
+\b0 \
+Copyright (c) 2010, Owain R Hunt. All rights reserved.\
+\
+
+\b The Short Version\
+
+\b0 Use the code however you like, pass it around, change it, tweak it, build on it, release it, just make sure you include the line
+\b Includes UAGithubEngine by Owain R Hunt
+\b0 , preferably in your app's About box or equivalent.\
+\
+
+\b The Full Legalese
+\b0 \
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\
+ * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\
+ * Redistributions in binary form must include the following notice, preferably in the software's About box or suitable equivalent:\
+
+\b Includes UAGithubEngine by Owain R Hunt
+\b0 \
+ * Neither the name Owain R Hunt nor the names of contributors to the code may be used to endorse or promote products derived from this software without specific prior written permission.\
+\
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL OWAIN R HUNT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.}
View
53 README
@@ -0,0 +1,53 @@
+#UAGithubEngine
+by [Owain R Hunt](http://owainrhunt.com/ "Owain R Hunt")
+
+UAGithubEngine is a practically-complete wrapper around the Github API (the exceptions being the network graph and Gist APIs, which are currently not implemented). Check out the [API documentation](http://develop.github.com/ "Github API Documentation) for full details of what the API can do.
+
+##How do I use it?
+
+* Copy across all the files in the 'Engine' group from the UAGithubEngine project into your app's project.
+
+* Where you want to use the engine, follow the example from the included AppController class, making sure you `#import "UAGithubEngine.h"`, and that your class adopts the `UAGithubEngineDelegate` protocol.
+
+* Implement *at least* the following delegate methods:
+
+ `- (void)requestSucceeded:(NSString *)connectionIdentifier;`
+
+ `- (void)requestFailed:(NSString *)connectionIdentifier withError:(NSError *)error;`
+* Implement your choice of the remaining delegate methods, depending on your particular needs:
+
+ `- (void)connectionStarted:(NSString *)connectionIdentifier;`
+
+ `- (void)connectionFinished:(NSString *)connectionIdentifier;`
+
+ `- (void)usersReceived:(NSArray *)users forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)repositoriesReceived:(NSArray *)repositories forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)deployKeysReceived:(NSArray *)deployKeys forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)collaboratorsReceived:(NSArray *)collaborators forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)languagesReceived:(NSArray *)languages forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)tagsReceived:(NSArray *)tags forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)branchesReceived:(NSArray *)branches forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)commitsReceived:(NSArray *)commits forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)issuesReceived:(NSArray *)issues forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)labelsReceived:(NSArray *)labels forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)issueCommentsReceived:(NSArray *)issueComments forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)treeReceived:(NSArray *)treeContents forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)blobsReceieved:(NSArray *)blobs forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)blobReceived:(NSArray *)blob forConnection:(NSString *)connectionIdentifier;`
+
+ `- (void)rawBlobReceived:(NSData *)blob forConnection:(NSString *)connectionIdentifier;`
+
+
View
@@ -19,6 +19,8 @@
#import "UAGithubEngineRequestTypes.h"
#import "UAGithubURLConnection.h"
+#import "NSString+UAGithubEngineUtilities.h"
+
#define API_DOMAIN @"https://github.com/api"
#define API_VERSION @"v2"
@@ -4,6 +4,4 @@
#ifdef __OBJC__
#import <Cocoa/Cocoa.h>
- #import "NSString+UAGithubEngineUtilities.h"
- #import "NSArray+Utilities.h"
#endif
View
@@ -8,6 +8,8 @@
#import "UAGithubJSONParser.h"
#import "CJSONDeserializer.h"
+#import "NSArray+Utilities.h"
+#import "NSString+UAGithubEngineUtilities.h"
@implementation UAGithubJSONParser

0 comments on commit 42f38c2

Please sign in to comment.