README.md in rails3-jquery-autocomplete-1.0.11 vs README.md in rails3-jquery-autocomplete-1.0.12

- old
+ new

@@ -1,5 +1,49 @@ +## Status + +As you may have noticed we are working through the backlog of issues and pull requests +and trying to get those caught up. Couple of quick notes related to this. + +1. A new gem with Rails 4 will be forthcoming so users on Rails 4 don't need to point to master. +2. If there is a specific feature that is in master, but not in the gem I strongly suggest you + point to the specific changeset that addresses your issue rather than directly at master. There + are going to be a lot of changes going on here and while we will do our best; there will probably + be some breakage on master in the short term. Use at your discretion! +3. Some pull requests have been submitted to address the same functionality; in those cases we will try + to pick the best/optimal solution, accept that and close out the other tickets. +4. Backwards compatibility is considered a high priority, so if a pull request is a great idea, + but it breaks backwards compatibility, it will be closed and noted that it causes breakage + to backwards compatibility. If anyone passionately wants the feature they are welcome to update + in a way that maintiains backwards compatibility and issue new pull reqs. +5. Performance is critical. If a feature is a nice to have, but has been implemented in such a way that it causes + performance degradation to existing searches; it will be rejected. +6. Thanks to everyone who is submitting pull requests, issues, comments, etc... I appreciate the help + from each one of you. Sometimes it has to get worse before it gets better. But I promise, + it will get better! + +------- + +Thanks to David @ crowdint for creating this gem and all of his hard +work on it in the past. + +Just posting this update to let everyone know this project is still +alive and has a new maintainer. Over the next couple of weeks we will +be reviewing existing pull requests and you will see updates shortly. + +Thanks for your patience. + +joiey-seeley@uiowa.edu + +------- + +Unfortunately, I don't have much time to work on this gem, I'm looking for +someone to help with its maintenance. Send me an email if you are interested in +getting push privileges to this repo. + +david@crowdint.com + + # rails3-jquery-autocomplete [![Build Status](https://secure.travis-ci.org/crowdint/rails3-jquery-autocomplete.png)](http://travis-ci.org/crowdint/rails3-jquery-autocomplete) An easy way to use jQuery's autocomplete with Rails 3. @@ -65,11 +109,11 @@ If you want to make changes to the JS file, you can install the uncompressed version by running: rails generate autocomplete:uncompressed -### Rails 3.1.x +### Rails 3.1.x and higher Just add it to your app/assets/javascripts/application.js file //= require jquery //= require jquery_ujs @@ -200,11 +244,11 @@ #### Multiple Values Separated by Delimiter To generate an autocomplete input field that accepts multiple values separated by a given delimiter, add the `'data-delimiter'` and `:multiple` options: form_for @product do |f| - f.autocomplete_field :brand_names, autocomplete_brand_name_products_path, + f.autocomplete_field :brand_names, autocomplete_brand_name_products_path, 'data-delimiter' => ',', :multiple => true end NOTE: Setting the `:multiple` option to `true` will result in the chosen values being submitted as an array. Leaving this option off will result in the values being passed as a single string, with the values separated by your chosen delimiter. @@ -337,11 +381,11 @@ while you're developing, it is recommended that you run bundle exec guard -to have the relevent test run every time you save a file. +to have the relevant test run every time you save a file. ## Integration tests If you make changes or add features to the jQuery part, please make sure you write a cucumber test for it. @@ -355,10 +399,10 @@ rake db:migrate cucumber ## Where to test what -If you're making or tweaking a plugin (such as the formastic plugin or +If you're making or tweaking a plugin (such as the formtastic plugin or simple\_form plugin), check out the simple\_form\_plugin\_test for an example of how to test it as part of the main `rake test` run. Historically, plugins like these had been tested (shoddily) as part of the integration tests. Feel free to remove them from the integration suite and move them into the main suite. Your tests will run much