Browse files

update readme, make docs clearer, remove google group, etc

  • Loading branch information...
1 parent 0a8a57f commit c462c094d45b529518549a2b157eb28ce775a276 @justinfrench committed Jun 6, 2012
Showing with 12 additions and 16 deletions.
  1. +12 −16 README.textile
@@ -5,6 +5,15 @@ Formtastic is a Rails FormBuilder DSL (with some other goodies) to make it far e
<a href=''><img alt='Click here to lend your support to: formtastic and make a donation at !' src='' border='0' /></a>
+h2. Documentation & Support
+* "Documentation is available on":
+* "We track issues & bugs on GitHub":
+* "We have a wiki on GitHub":
+* "StackOverflow can help":
+* "Follow @formtastic on Twitter for news & updates":
h2. Compatibility
* Formtastic 2.1.x is Rails 3.x compatible
@@ -75,11 +84,6 @@ h2. Opinions
* Make the common things we do easy, yet ensure uncommon things are still possible.
-h2. Documentation
-RDoc documentation _should_ be automatically generated after each commit and made available on the " website":
h2. Installation
Simply add Formtastic to your Gemfile and bundle it up:
@@ -608,28 +612,20 @@ Formtastic::FormBuilder.escape_html_entities_in_hints_and_labels = false
h2. Dependencies
-There are none, but...
+There are none other than Rails itself, but...
* If you want to use the @:country@ input, you'll need to install the "country-select plugin": (or any other country_select plugin with the same API).
-* "rspec":, "rspec_hpricot_matchers": and "rcov": gems (plus any of their own dependencies) are required for the test suite.
+* There are a bunch of development dependencies
h2. How to contribute
* Fork the project on Github
* Create a topic branch for your changes
+* Ensure that you provide test coverage for your changes
* Ensure that all tests pass (`bundle exec rake`)
-* Ensure that the changes in your branch are as atomic as possible
* Create a pull request on Github
-For significant changes, you may wish to discuss your idea on the Formtastic Google group before coding to ensure that your change is likely to be accepted. Formtastic relies heavily on i18n, so if you're unsure of the impact this has on your changes, please discuss them with the group.
-h2. Google Group, Twitter, etc
-Please join the "Formtastic Google Group":, especially if you'd like to talk about a new feature, or report a bug.
-You can also follow "@justinfrench": or "@formtastic": on Twitter for announcements, tutorials and links.
h2. Project Info

0 comments on commit c462c09

Please sign in to comment.