README.md in easyxdm-rails-0.0.1 vs README.md in easyxdm-rails-0.0.2
- old
+ new
@@ -3,16 +3,67 @@
easyxdm-rails is the easiest way to include easyXDM in your rail app.
Currently includes files from : easyXDM-2.4.16.3.zip
-Intallation
+Installation
--------------
Add this to your Gemfile:
gem 'easyxdm-rails'
+Then you can add this to one of your js manifest files (like
+app/assets/javascripts/application.js)
+
+ //= require easyxdm-rails/easyXDM
+
+Or if you're still in development mode, you may want to do this:
+
+ //= require easyxdm-rails/easyXDM.debug
+
+Since you're using easyXDM, there's a good chance that you need to be
+able to serve easyXDM.js by itself, or in conjuction with your other
+scripts.
+
+To serve it by itself you could add this to
+config/environments/production.rb
+
+ config.assets.precompile += %w( easyxdm-rails/easyXDM.js )
+
+Then you could refer to :
+
+ http://your-host/assets/easyxdm-rails/easyXDM.js
+
+Or you could create a new manifest, bookmarklet.js for example, in
+app/assets/javascripts and include both easyXDM.js and your code.
+
+ //= require easyxdm-rails/easyXDM
+ //= require your-bookmarklet-code.js
+
+Then you could get both easyXDM and your code by refering to:
+
+ http://your-host/assets/bookmarklet.js
+
+
+Example
+-------------
+
+You can check the source for the easyxdm-rails-example project:
+
+https://github.com/Octo-Labs/easyxdm-rails-example
+
+You can also see tha project deployed here:
+
+http://easyxdm-rails-example.herokuapp.com/
+
+You can see easyXDM included in the application.js here:
+
+http://easyxdm-rails-example.herokuapp.com/assets/application.js
+
+And you can see it delivered by itself here:
+
+http://easyxdm-rails-example.herokuapp.com/assets/easyxdm-rails/easyXDM.js
This project rocks and uses MIT-LICENSE.