README.md in opal-jquery-0.0.11 vs README.md in opal-jquery-0.0.12
- old
+ new
@@ -6,25 +6,37 @@
and providing a nice ruby syntax for dealing with jQuery instances.
opal-jquery is [hosted on github](http://github.com/opal/opal-jquery).
See the [website for documentation](http://opalrb.org/jquery).
-### Running Specs
+## Documentation
+### HTTP
+
+The `HTTP` class wraps jQuery's ajax request into a ruby class.
+
+```ruby
+HTTP.get("/users/1.json") do |response|
+ puts "Got response!"
+end
+```
+
+## Running Specs
+
Get the dependencies:
$ bundle install
-#### Browser
+### Browser
You can run the specs in any web browser, by running the `config.ru` rack file:
$ bundle exec rackup
And then visiting `http://localhost:9292` in any web browser.
-#### Phantomjs
+### Phantomjs
You will need phantomjs to run the specs outside the browser. It can
be downloaded at [http://phantomjs.org/download.html](http://phantomjs.org/download.html)
On osx you can install through homebrew
@@ -33,10 +45,12 @@
Run the tests inside a phantom.js runner:
$ bundle exec rake
-### License
+## License
+
+(The MIT License)
Copyright (C) 2013 by Adam Beynon
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal