README.md in abracadabra-1.0.4 vs README.md in abracadabra-1.0.5

- old
+ new

@@ -1,8 +1,8 @@ # Abracadabra -A lightweight gem for swapping out text with a fully-compliant Rails form in one click. +A lightweight gem for swapping out text with a fully-compliant Rails 4 form in one click. Much of the concepts and html mark-up were taken from the awesome [x-editable](http://vitalets.github.io/x-editable/) plugin and the Rails version of this, [x-editable-rails](https://github.com/werein/x-editable-rails). However, this was written from the ground up and uses fully Rails-compliant forms without hacking into x-editable's core files, or overriding them. ## Installation @@ -34,17 +34,17 @@ //= require abracadabra ``` ## Helpers -The bread and butter of abracadabra is its helper, `click_to_edit`. Its pretty much as readable as it gets: +The bread and butter of abracadabra is its helper, `click_to_edit`. It's pretty much as readable as it gets: ```ruby <%= click_to_edit @user, path: user_path(@user), attribute: :name %> ``` -When a user clicks the link generated by this helper, a form with a text field input will replace the link. It's fully Rails compliant, and looks identical to a `form_for` with `remote: true`. Here's what it looks like: +When a user clicks the link generated by this helper, a form with a text field input will replace the link. It's fully Rails compliant, and the form markup that is generated is identical to a `form_for` with `remote: true`. Here's what it looks like: ![Abracadabra Demo](http://recordit.co/CbgPTahYix.gif "Abracadabra Demo") The first parameter of `click_to_edit` is the object to be edited, and the only other required parameters are `path` and `attribute`. `path` specifies where the form will be submitted, and `attribute` specifies the column being updated. @@ -71,11 +71,11 @@ method: "patch" # HTTP REST method to use. Use anything but "get". # Default: "patch" remote: true -# Same as link_to's remote: true, form submits via AJAX. +# Same as link_to's `remote: true`, form submits via AJAX. # Default: true # IMPORTANT: `type` will be ignored if `remote = false` is used. HTML is the default # in Rails for standard form submissions. type: :js @@ -86,9 +86,13 @@ ## Future & Contributing 1. I would love anyone to add date pickers and other alternate field types to this. 2. I would love the different Bootstrap classes to be overridable with an initializer (config/abracadabra.rb) so that any framework could be used. Same with the Font-Awesome button classes. + +3. I would love for a `buttons: false` option to be offered that would allow only `Tab`, `Enter` and `Escape` to submit or cancel the form submission. + +4. I would love for a `tabbable: true` option to be offered that would tab to the next text input with the `abracadabra` class. Any other ideas, feel free to contribute! 1. Fork it ( http://github.com/TrevorHinesley/abracadabra/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`)