README.textile in optionsful-0.5.2 vs README.textile in optionsful-0.5.3
- old
+ new
@@ -61,26 +61,30 @@
...</pre>
# To install it, run @bundle install@ or:
<pre>$ gem install optionsful</pre>
# Enjoy! And give feedback! :)
-h1. CONFIGURATION
+h1. CONFIGURATION:
h2. Setting up the @Link@ header
* To enable and setup the response's @Link@ header, install and edit the configuration file:
** run @rake optionsful:yml@
** edit the 'optionsful.yml' file at your application's 'config' folder.
* Example:
-<pre>development:
- link: true
- host: auto
- base_path: /api
- propagate: true</pre>
-h2. Possible values and effects: (the underline values are the default ones)
+<pre>
+development:
+ link: true
+ host: auto
+ base_path: /api
+ propagate: true
+</pre>
+
+h2. Possible values and effects: (the underlined values are the default ones)
+
* @link@
** [+false+]: Do not include the "Link" in the response headers.
*** some other settings are then ignored
** true: Do include it!
*** build the *URI* based on the *host*, *base_path*, and *propagate* values, explained below.
@@ -108,13 +112,28 @@
* *Note*: @Allow@ *and* @Link@ *are expected headers on a response to an HTTP OPTIONS request.*
h2. KNOWN ISSUES
* Rails route recognition still need some work
-h2. Development notes
+h2. Developer notes
-* To bleed on the edge, at your Rails 3 application's @Gemfile@:
+<pre>
+ $ cd ~/your_workspace
+ $ git clone git@github.com:kayaman/optionsful.git
+ $ cd optionsful
+ $ rake
+</pre>
+
+* To bleed on the edge, add at your Rails 3 application's @Gemfile@:
<pre>gem 'optionsful', :path => "~/your_workspace/optionsful/"</pre>
+
+* TODO: check dependencies.
+
+h2. TODOs
+
+* RSpec 2.0 => http://github.com/rspec/rspec-core/blob/master/Upgrade.markdown
+* spec_helper allow_only(headers, *method)
+
h2. Get involved
* Mailing list: http://groups.google.com/group/optionsful
* Bug tracker : http://kayaman.lighthouseapp.com/projects/56438-optionsful/overview