Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

added documentation

  • Loading branch information...
commit 206d170c66f843d271be6196e50cb889f4de49b1 1 parent 2dfb259
Marty Schoch authored
62 README.md
Source Rendered
... ... @@ -1 +1,63 @@
1 1 ### iOS Couchbase User
  2 +
  3 +iOS Couchbase User is the place to start for anyone interested in embedding Apache CouchDB into their iOS application.
  4 +
  5 +### Getting Started
  6 +
  7 +##### Get a copy of iOS Couchbase User
  8 +
  9 + git clone git://github.com/mschoch/iOS-Couchbase-User.git
  10 +
  11 +##### Installing the Xcode Project Templates
  12 +
  13 + cd iOS-Couchbase-User/
  14 + open CouchbaseUser.xcworkspace/
  15 +
  16 +<img src="https://github.com/mschoch/iOS-Couchbase-User/raw/master/doc/resources/001.png" width="400"/>
  17 +
  18 + Select "Download Couchbase" from the Scheme popup
  19 + Click the Run button, this will download a recent version of the Couchbase binaries suitable for embedding in an iOS application
  20 + Select "Install Xcode Project Templates" from the Scheme popup
  21 + Click the Run button, at this point you should now have Couchbase Project Templates installed in your ~/Library/Developer/Xcode/Templates folder
  22 +
  23 +<img src="https://github.com/mschoch/iOS-Couchbase-User/raw/master/doc/resources/002.png" width="400"/>
  24 +
  25 +##### Starting a New Project using a Couchbase Template
  26 +
  27 + Select File > New > New Project... `&#8679; &#8984; N`
  28 +
  29 +<img src="https://github.com/mschoch/iOS-Couchbase-User/raw/master/doc/resources/003.png" width="400"/>
  30 +
  31 + Select Couchbase Navigation-based Application and press the Next button
  32 +
  33 +<img src="https://github.com/mschoch/iOS-Couchbase-User/raw/master/doc/resources/004.png" width="400"/>
  34 +
  35 + Provide a Product Name and press the Next button
  36 +
  37 +<img src="https://github.com/mschoch/iOS-Couchbase-User/raw/master/doc/resources/005.png" width="400"/>
  38 +
  39 + Provide a location for Xcode to save the new project and press the Create button
  40 +
  41 +<img src="https://github.com/mschoch/iOS-Couchbase-User/raw/master/doc/resources/006.png" width="400"/>
  42 +
  43 + You should now have a new project created that looks like the image above.
  44 + Select "Your Application - iPhone Simulator" from the Scheme popup
  45 + Press the Run button
  46 +
  47 +<img src="https://github.com/mschoch/iOS-Couchbase-User/raw/master/doc/resources/007.png" width="400"/>
  48 +
  49 + You should now see the same basic iPhone screen as you get with the Navigation Application template.
  50 +
  51 +<img src="https://github.com/mschoch/iOS-Couchbase-User/raw/master/doc/resources/008.png" width="400"/>
  52 +
  53 + And in the Xcode console you should see a message indicating the URL that CouchDB is accessible at and a message that "Couch is ready!"
  54 +
  55 +### Next Steps
  56 +
  57 + To see whats possible and get ideas for how to further integrate your application with CouchDB we suggest you look at the following applications:
  58 +
  59 + Mobile Couchbase Demo.app - https://github.com/couchbaselabs/iOS-Couchbase/tree/master/Demo
  60 + OnTheSpot - https://github.com/couchbaselabs/OnTheSpot
  61 +
  62 + Also, if you'd like to use an Objective-C library to access CouchDB, consider Trundle - https://github.com/schwa/trundle
  63 +
BIN  doc/resources/001.png
BIN  doc/resources/002.png
BIN  doc/resources/003.png
BIN  doc/resources/004.png
BIN  doc/resources/005.png
BIN  doc/resources/006.png
BIN  doc/resources/007.png
BIN  doc/resources/008.png

0 comments on commit 206d170

Please sign in to comment.
Something went wrong with that request. Please try again.