Merge branch 'master' of github.com:twotoasters/RestKit

This commit is contained in:
Blake Watters
2010-02-18 10:50:41 -05:00
2 changed files with 39 additions and 24 deletions

24
README
View File

@@ -1,24 +0,0 @@
RetKit is a library for interacting with Restful web services in Objective C. It provides a set of primitives for interacting with web services wrapping GET, POST, PUT and DELETE HTTP verbs behind a clean, simple interface. RestKit also provides a system for modeling remote resources by mapping them from XML/JSON payloads back into domain objects. Model mapping functions with normal NSObject derived classes with properties. There is also a model mapping implementation included that provides a Core Data backed store for persisting objects loaded from the web.
# Dependencies
RestKit currently utilizes ElementParser for parsing XML payloads and JSON framework for parsing JSON payloads.
Additional parsing backend support is expected in future versions.
# Installation
To add RestKit to your project (you're using git, right?):
git submodule add git://github.com/twotoasters/ElementParser.git ElementParser
git submodule add git://github.com/twotoasters/RestKit.git RestKit
git submodule add git://github.com/stig/json-framework.git json-framework
Open RestKit.xcodeproj and drag the RestKit project file into your XCode project.
Next add RestKit as a direct dependency to your target.
Add 'RestKit' and 'ElementParser/Classes' to your target's header search paths.
Add libRestKit.a to your target (checkbox)
Be sure to enable the -ObjC in your Target settings under "Build" > "Other Linker Flags"

39
README.md Normal file
View File

@@ -0,0 +1,39 @@
Introduction
=========================
RestKit is a library for interacting with Restful web services in Objective C. It provides a set of primitives for interacting with web services wrapping GET, POST, PUT and DELETE HTTP verbs behind a clean, simple interface. RestKit also provides a system for modeling remote resources by mapping them from XML/JSON payloads back into domain objects. Model mapping functions with normal NSObject derived classes with properties. There is also a model mapping implementation included that provides a Core Data backed store for persisting objects loaded from the web.
Dependencies
-------------------------
RestKit currently utilizes ElementParser for parsing XML payloads and JSON framework for parsing JSON payloads.
Additional parsing backend support is expected in future versions.
Installation
-------------------------
To add RestKit to your project (you're using git, right?):
* git submodule add git://github.com/twotoasters/ElementParser.git ElementParser
* git submodule add git://github.com/stig/json-framework.git json-framework
* git submodule add git://github.com/twotoasters/RestKit.git RestKit
Open RestKit.xcodeproj and drag the RestKit project file into your XCode project.
Next add RestKit as a direct dependency to your target.
Add 'RestKit' and 'ElementParser/Classes' to your target's header search paths.
Add libRestKit.a to your target (checkbox)
Be sure to enable the -ObjC in your Target settings under "Build" > "Other Linker Flags"
Contributing
-------------------------
Forks, patches and other feedback are always welcome.
A Google Group for development and usage of library is available at: [http://groups.google.com/group/restkit](http://groups.google.com/group/restkit)
### RestKit is brought to you by [Two Toasters](http://www.twotoasters.com/). ###