README.md in formtastic-bootstrap-1.0.1 vs README.md in formtastic-bootstrap-1.0.2
- old
+ new
@@ -1,9 +1,11 @@
# Formtastic Bootstrap
A [Formtastic](https://github.com/justinfrench/formtastic) form builder that creates markup suitable for the [Twitter Bootstrap](http://twitter.github.com/bootstrap/) framework. In theory, it should just work. Two great tastes in one!
+You can follow [FormBoot on twitter](http://twitter.com/FormBoot) for update announcements and other relevant info.
+
## Getting Started
### Dependencies
Formtastic Bootstrap has only been tested with Ruby 1.9.2, Rails 3.1, Formtastic 2.0 and Twitter Bootstrap 1.3.
@@ -82,11 +84,11 @@
<span class="help-inline">This is the title!</span>
</div>
</div>
</fieldset>
<div class="actions">
- <input class="btn create" name="commit" type="submit" value="Create Post" />
+ <input class="btn create commit" name="commit" type="submit" value="Create Post" />
</div>
</form>
### Major Difference in Behavior
@@ -94,13 +96,16 @@
* Formtastic Bootstrap puts the <tt>input</tt> label in a different place because it makes Bootstrap behave correctly.
* Formtastic Bootstrap renders <tt>:date</tt>, <tt>:datetime</tt> and <tt>:time</tt> as text fields since this is how Twitter Bootstrap presents these data types (Formtastic renders them as dropdowns.) Some Rails magic may have been lost here. Additionally:
* <tt>:date</tt> et al are tagged with the <tt>stringish</tt> class.
* Hidden fields are not generated.
* Fieldsets are simply nested.
+* <tt>f.buttons :name</tt> is not supported. This generates a <tt>fieldset</tt> and <tt>legend</tt> tag which will cause the wrong thing to happen in Bootstrap.
Bootstrap is somewhat incomplete, and in a few cases an inference needed to be drawn to determine a course of action. If you disagree with any of these choices, feel free to let me know.
+(At some point, this gem may also provide some additional CSS to cover cases left unaddressed by Bootstrap, but its obvious what should be done. That's not going to happen any time soon though!)
+
### Other
A lot of the code (especially the test suite) was copied over from Formtastic and then beaten into submission. I'm sure you'll find some ugliness in there. In general, I mimicked the Formtastic code structure as much as possible.
In particular:
@@ -117,9 +122,19 @@
* Formtastic's <tt>:country</tt> and <tt>:time_zone</tt> have not yet been implemented.
* Twitter Bootstrap's Date Range, Prepend Text, Prepend Checkbox and Appended Checkbox controls have not yet been implemented.
## Contributing to formtastic-bootstrap
+### Submitting Issues
+
+If you're filing a bug, thank you! Secondly, in the report please include:
+
+* The version of Formtastic you're using.
+* The version of Twitter Bootstrap you're using.
+* The code for your form.
+* Anything else you think will help!
+
+### Source Contributions
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution