Point towards website for docs

adambeynon · adambeynon · commit cedfa6cb9175 · 2014-11-20T12:19:30.000Z
diff --git a/README.md b/README.md
@@ -7,23 +7,7 @@ and providing a nice ruby syntax for dealing with jQuery instances.
 
 See the Opal website for [documentation](http://opalrb.org/docs/jquery).
 
-## Documentation
-
-```ruby
-elements = Element.find('.foo')
-# => [<div class="foo">, ...]
-
-elements.class
-# => JQuery
-
-elements.on(:click) do
-  alert "element was clicked"
-end
-```
-
-### Getting Started
-
-#### Installation
+## Installation
 
 Install opal-jquery from RubyGems:
 
@@ -36,197 +20,6 @@ Or include it in your Gemfile for Bundler:
 ```ruby
 gem 'opal-jquery'
 ```
-
-### Interacting with the DOM
-
-#### Finding elements
-
-opal-jquery provides the `Element` class, which can be used to find elements in
-the current document:
-
-```ruby
-Element.find('#header')
-```
-
-`Element.find` is aliased to `Element[]`:
-
-```ruby
-Element['.my-class']
-```
-
-These methods acts just like `$('selector')`, and can use any jQuery
-compatible selector:
-
-```ruby
-Element.find('#navigation li:last')
-```
-
-The result is just a jQuery instance, which is toll-free bridged to
-instances of the `Element` class in ruby:
-
-```ruby
-Element.find('.foo').class
-# => Element
-```
-
-Instances of `Element` also have the `#find` method available for
-finding elements within the scope of each DOM node represented by
-the instance:
-
-```ruby
-el = Element.find('#header')
-el.find '.foo'
-# => #<Element .... >
-```
-
-#### Running code on document ready
-
-Just like jQuery, opal-jquery requires the document to be ready to
-be able to fully interact with the page. Any top level access should
-use the `ready?` method:
-
-```ruby
-Document.ready? do
-  alert "document is ready to go!"
-end
-```
-
-The `Kernel#alert` method is shown above too.
-
-#### Event handling
-
-The `Element#on` method is used to attach event handlers to elements:
-
-```ruby
-Element.find('#header').on :click do
-  puts "The header was clicked!"
-end
-```
-
-Selectors can also be passed as a second argument to handle events
-on certain children:
-
-```ruby
-Element.find('#header').on(:click, '.foo') do
-  puts "An element with a 'foo' class was clicked"
-end
-```
-
-An `Event` instance is optionally passed to block handlers as well,
-which is toll-free bridged to jquery events:
-
-```ruby
-Element.find('#my_link').on(:click) do |evt|
-  evt.stop_propagation
-  puts "stopped the event!"
-end
-```
-
-#### CSS styles and classnames
-
-The various jQuery methods are available on `Element` instances:
-
-```ruby
-foo = Element.find('.foo')
-
-foo.add_class 'blue'
-foo.remove_class 'foo'
-foo.toggle_class 'selected'
-```
-
-There are also added convenience methods for opal-jquery:
-
-```ruby
-foo = Element.find('#header')
-
-foo.class_name
-# => 'red lorry'
-
-foo.class_name = 'yellow house'
-
-foo.class_name
-# => 'yellow house'
-```
-
-`Element#css` also exists for getting/setting css styles:
-
-```ruby
-el = Element.find('#container')
-el.css 'color', 'blue'
-el.css 'color'
-# => 'blue'
-```
-
-### HTTP/AJAX requests
-
-jQuery's Ajax implementation is also wrapped in the top level HTTP
-class.
-
-```ruby
-HTTP.get("/users/1.json") do |response|
-  puts response.body
-  # => "{\"name\": \"Adam Beynon\"}"
-end
-```
-
-The block passed to this method is used as the handler when the request
-succeeds, as well as when it fails. To determine whether the request
-was successful, use the `ok?` method:
-
-```ruby
-HTTP.get("/users/2.json") do |response|
-  if response.ok?
-    alert "successful!"
-  else
-    alert "request failed :("
-  end
-end
-```
-
-The request is actually triggered inside the `HTTP.get` method, but due
-to the async nature of the request, the callback and errback handlers can
-be added anytime before the request returns.
-
-#### Handling responses
-
-Web apps deal with JSON responses quite frequently, so there is a useful
-`#json` helper method to get the JSON content from a request:
-
-```ruby
-HTTP.get("/users.json") do |response|
-  puts response.body
-  puts response.json
-end
-
-# => "[{\"name\": \"Adam\"},{\"name\": \"Ben\"}]"
-# => [{"name" => "Adam"}, {"name" => "Ben"}]
-```
-
-The `#body` method will always return the raw response string.
-
-If an error is encountered, then the `#status_code` method will hold the
-specific error code from the underlying request:
-
-```ruby
-request = HTTP.get("/users/3.json")
-
-request.callback { puts "it worked!" }
-
-request.errback { |response|
-  puts "failed with status #{response.status_code}"
-}
-```
-
-#### Other options
-
-`HTTP` accepts the usual `$.ajax` options:
-
-```ruby
-HTTP.get '/search', data: {q: 'foo'}, async: false do |response|
-  p response.body
-end
-```
-
 ## Running Specs
 
 Get the dependencies:
