Skip to content

Commit

Permalink
add "Getting Started" to README
Browse files Browse the repository at this point in the history
  • Loading branch information
siuying committed May 8, 2012
1 parent da2f970 commit afdd51c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Expand Up @@ -2,6 +2,28 @@

A collection of helpers and wrappers used to wrap CocoaTouch code and provide more Ruby like APIs.

## Getting started

Add BubbleWrap as a git submodule of your RubyMotion project:

git clone https://github.com/mattetti/BubbleWrap.git vendor/BubbleWrap

Add the BubbleWrap lib path to your project 'Rakefile'

Motion::Project::App.setup do |app|
app.name = 'myapp'
app.files += Dir.glob(File.join(app.project_dir, 'vendor/BubbleWrap/lib/**/*.rb'))
end

Now, you can use BubbleWrap extension in your app:

class AppDelegate
def application(application, didFinishLaunchingWithOptions:launchOptions)
puts "#{App.name} (#{documents_path})"
true
end
end

## HTTP

`BubbleWrap::HTTP` wraps `NSURLRequest`, `NSURLConnection` and friends to provide Ruby developers with a more familiar and easier to use API.
Expand Down

0 comments on commit afdd51c

Please sign in to comment.