Skip to content

Commit

Permalink
#3 Updated README to include getting started info
Browse files Browse the repository at this point in the history
  • Loading branch information
Joshua Vickery committed Oct 17, 2008
1 parent 78e57e4 commit 423321d
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README
@@ -0,0 +1,21 @@
h2. Overview

ObjectiveResource is a port of Rail's ActiveRecord framework to Objective-C.

The primary purpose of this project is to quickly and easily connect
iPhone applications with servers running Rails.

A secondary goal of this project is to provide some popular Rubyisms to
Objective-C. This work can be found in the ActiveSupport group.

h2. Getting Started
h3. Sample Code
This project comes bundled with a sample iPhone application and a sample
Rails application. To see how everything works together you can open
up the .xcodeproj and fire up a rails server in sample_rails_app.

h3. Integrating with your project
# Download (clone) the objectiveresource project
## If you are using git you can checkout objectiveresource as a submodule
# open the .xcodeproj in XCode for both objectiveresource and your iPhone project
# drag the ActiveResource and ActiveSupport groups from the objectiveresource project onto your iPhone project

0 comments on commit 423321d

Please sign in to comment.