Commits

Dallas Brown committed f28a13c

Updated ReadMe and License

Comments (0)

Files changed (2)

 # License
 
-## The Cocoa XML-RPC Framework is distributed under the MIT License:
+## The Cocoa Touch XML-RPC Framework is distributed under the MIT License:
 
+Copyright (c) 2011 Dallas Brown <dallas@mokinetworks.com>
 Copyright (c) 2010 Eric Czarny <eczarny@gmail.com>
 
-Permission  is hereby granted, free of charge, to any person obtaining a copy of
-this  software  and  associated documentation files (the "Software"), to deal in
-the  Software  without  restriction,  including without limitation the rights to
-use,  copy,  modify,  merge, publish, distribute, sublicense, and/or sell copies
-of  the  Software, and to permit persons to whom the Software is furnished to do
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
 so, subject to the following conditions:
 
-The  above  copyright notice and this permission notice shall be included in all
+The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE  SOFTWARE  IS  PROVIDED  "AS  IS",  WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# The Cocoa XML-RPC Framework
+==The Cocoa Touch XML-RPC Framework==
 
-The  Cocoa  XML-RPC  Framework  is  a  simple,  and  lightweight, XML-RPC client
-framework written in Objective-C.
+The Cocoa Touch XML-RPC Framework is a simple, and lightweight, XML-RPC client
+framework written in Objective-C for use on iOS devices.
+This project was forked off of Eric Czarny's XMLRPC project, which can be located at: https://github.com/eczarny/xmlrpc
 
-# Requirements
+Extra code, test client and server, and unit tests have been removed for ease of conversion, but may be re-integrated based on users needs/wants.
 
-The  Cocoa  XML-RPC Framework has been built, and designed, for Mac OS X 10.5 or
-later. This release should provide basic iPhone and iPod touch support.
+===Requirements===
 
-This  version  of  the  Cocoa  XML-RPC  Framework includes a new event-based XML
-parser.  The  previous  tree-based XML parser still exists, but is no longer the
-default  XML-RPC  response  parser  nor included in the Xcode build. This should
+The Cocoa Touch XML-RPC Framework has been built, and designed, for iOS 4.0 or
+later.
+
+This version of the Cocoa Touch XML-RPC Framework includes a new event-based XML
+parser. The previous tree-based XML parser still exists, but is no longer the
+default XML-RPC response parser nor included in the Xcode build. This should
 hopefully provide better compatibility with the iPhone SDK.
 
-# Usage
-
-The  following  example of the Cocoa XML-RPC Framework assumes that the included
-XML-RPC  test  server  is  available. More information on the test server can be
-found in the README under:
-
-    XMLRPC\Tools\Test Server
-
-Please review this document before moving forward.
-
-## Invoking XML-RPC requests through the XML-RPC connection manager
+===Usage===
 
 Invoking an XML-RPC request through the XML-RPC connection manager is easy:
 
-    NSURL *URL = [NSURL URLWithString: @"http://127.0.0.1:8080/"];	
-    XMLRPCRequest *request = [[XMLRPCRequest alloc] initWithURL: URL];
-    XMLRPCConnectionManager *manager = [XMLRPCConnectionManager sharedManager];
-    
-    [request setMethod: @"Echo.echo" withParameter: @"Hello World!"];
-    
-    NSLog(@"Request body: %@", [request body]);
-    
-    [manager spawnConnectionWithXMLRPCRequest: request delegate: self];
-    
-    [request release];
+{{{
+#!objective-c
 
-This  spawns  a  new XML-RPC connection, assigning that connection with a unique
-identifer  and  returning  it  to  the  sender.  This  unique identifier, a UUID
+NSURL *URL = [NSURL URLWithString: @"http://127.0.0.1:8080/"];	
+XMLRPCRequest *request = [[XMLRPCRequest alloc] initWithURL: URL];
+XMLRPCConnectionManager *manager = [XMLRPCConnectionManager sharedManager];
+
+[request setMethod: @"Echo.echo" withParameter: @"Hello World!"];
+
+NSLog(@"Request body: %@", [request body]);
+
+[manager spawnConnectionWithXMLRPCRequest: request delegate: self];
+
+[request release];
+}}}
+-
+
+This spawns a new XML-RPC connection, assigning that connection with a unique
+identifier and returning it to the sender. This unique identifier, a UUID
 expressed as an NSString, can then be used to obtain the XML-RPC connection from
 the XML-RPC connection manager, as long as it is still active.
 
-The  XML-RPC  connection  manager  has  been  designed to ease the management of
+The XML-RPC connection manager has been designed to ease the management of
 active XML-RPC connections. For example, the following method obtains an NSArray
 of active XML-RPC connection identifiers:
 
-    - (NSArray *)activeConnectionIdentifiers;
+{{{
+#!objective-c
 
-The  NSArray  returned  by this method contains a list of each active connection
-identifier.  Provided  with  a  connection identifier, the following method will
+- (NSArray*)activeConnectionIdentifiers;
+}}}
+-
+
+The NSArray returned by this method contains a list of each active connection
+identifier. Provided with a connection identifier, the following method will
 return an instance of the requested XML-RPC connection:
 
-    - (XMLRPCConnection *)connectionForIdentifier: (NSString *)connectionIdentifier;
+{{{
+#!objective-c
+
+- (XMLRPCConnection*)connectionForIdentifier:(NSString*)connectionIdentifier;
+}}}
+-
 
 Finally, for a delegate to receive XML-RPC responses, authentication challenges,
-or  errors,  the  XMLRPCConnectionDelegate  protocol  must  be  implemented. For
+or errors, the XMLRPCConnectionDelegate protocol must be implemented. For
 example, the following will handle successful XML-RPC responses:
+{{{
+#!objective-c
 
-    - (void)request: (XMLRPCRequest *)request didReceiveResponse: (XMLRPCResponse *)response {
-        if ([response isFault]) {
-            NSLog(@"Fault code: %@", [response faultCode]);
-            
-            NSLog(@"Fault string: %@", [response faultString]);
-        } else {
-            NSLog(@"Parsed response: %@", [response object]);
-        }
-        
-        NSLog(@"Response body: %@", [response body]);
-    }
+- (void)request:(XMLRPCRequest*)request didReceiveResponse:(XMLRPCResponse*)response
+{
+    NSLog(@"Response body: %@", [response body]);
+}
+}}}
+-
 
-Refer  to  XMLRPCConnectionDelegate.h for a full list of methods a delegate must
-implement.  Each of these delegate methods plays a role in the life of an active
+Refer to XMLRPCConnectionDelegate.h for a full list of methods a delegate must
+implement. Each of these delegate methods plays a role in the life of an active
 XML-RPC connection.
 
-## Sending synchronous XML-RPC requests
+===Sending synchronous XML-RPC requests===
 
-There  are  situations  where  it  may  be  desirable to invoke XML-RPC requests
-synchronously  in  another  thread  or  background process. The following method
+There are situations where it may be desirable to invoke XML-RPC requests
+synchronously in another thread or background process. The following method
 declared in XMLRPCConnection.h will invoke an XML-RPC request synchronously:
 
-    + (XMLRPCResponse *)sendSynchronousXMLRPCRequest: (XMLRPCRequest *)request error: (NSError **)error;
+{{{
+#!objective-c
+
++ (XMLRPCResponse*)sendSynchronousXMLRPCRequest:(XMLRPCRequest*)request error:(NSError**)error;
+}}}
+-
 
 If there is a problem sending the XML-RPC request expect nil to be returned.
 
-# What if I find a bug, or what if I want to help?
+===Acknowledgments===
 
-Please, contact me with any questions, comments, suggestions, or problems. I try
-to make the time to answer every request.
+The origins of this library come from Eric Czarny's XMLRPC code shared on GitHub.
 
-Those  wishing to contribute to the project should begin by obtaining the latest
-source  with  Git. The project is hosted on GitHub, making it easy for anyone to
-make contributions. Simply create a fork and make your changes.
-
-# Acknowledgments
-
-The  Base64  encoder/decoder found in NSStringAdditions and NSDataAdditions have
+The Base64 encoder/decoder found in NSStringAdditions and NSDataAdditions have
 been adapted from code provided by Dave Winer.
 
-The  idea  for  this framework came from examples provided by Brent Simmons, the
+The idea for this framework came from examples provided by Brent Simmons, the
 creator of NetNewsWire.
 
-# License
+===License===
 
+Copyright (c) 2011 Dallas Brown.
 Copyright (c) 2010 Eric Czarny.
 
-The  Cocoa XML-RPC Framework  should  be  accompanied  by  a  LICENSE file, this
-file  contains  the  license relevant to this distribution.
+This library is licensed under the MIT License.
 
-If no LICENSE exists please contact Eric Czarny <eczarny@gmail.com>.
+The Cocoa Touch XML-RPC Framework should be accompanied by a LICENSE file, this
+file contains the license relevant to this distribution.