formal 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,7 @@
 # Formal
 
-TODO: Write a gem description
+Formal is simply a form builder that provides the markup we typically use
+around form fields on Hashrocket projects.
 
 ## Installation
 
@@ -18,22 +19,62 @@ Or install it yourself as:
 
 ## Usage
 
-
 Specify the builder option in your form_for parameters
 
+```ruby
+= form_for post, builder: Formal::Builder do |f| 
+```
+
+
+```f.label``` gets wrapped in a ```<dt>``` or a ```<dt class="error">```(wherethere is an error)
+
+
+The following get wrapped in a ```<dd>``` or a ```<dd class="error">```:
+
+```ruby
+f.text_field
+f.password_field
+f.text_area
+f.select
+f.email_field
+f.search_field
 ```
-  = form_for post, builder: Formal::Builder do |f|
+
+__Example:__
+
+```ruby
+f.text_field :body 
 ```
 
-This will wrap a ```<dt>``` around labels and a ```<dd>``` around the following helpers:
+returns
+
+```HTML
+<dd>
+  <input type="text" id="post_body" name="post[body]" />
+</dd>
+```
+
+Also provided is a helper for a label with a checkbox __inside__ it (which is
+also wrapped in a ```<dt>```). Use:
+
+```ruby 
+f.checkbox_with_label :published
+```
+
+which returns:
+
+```html
+<dt>
+  <label for="post_published">
+     <input name="post[published]" type="hidden" value="0" />
+     <input id="post_published" name="post[published]" type="checkbox" value="1" /> 
+     published
+  </label>
+</dt>
+```
+
+
 
-- label_tag
-- text_field
-- password_field
-- text_area
-- select
-- email_field
-- search_field
 
 
 ## Contributing

data/formal.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = [""]
   gem.description   = %q{Helpful form builder used by Rocketeers}
   gem.summary       = %q{A form builder that wraps form fields the way we like it at Hashrocket}
-  gem.homepage      = "http://github.com/mrmicahcooper/formal"
+  gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/formal/version.rb

@@ -1,3 +1,3 @@
 module Formal
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formal
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies: []
 description: Helpful form builder used by Rocketeers
 email:
@@ -27,7 +27,7 @@ files:
 - formal.gemspec
 - lib/formal.rb
 - lib/formal/version.rb
-homepage: http://github.com/mrmicahcooper/formal
+homepage: ''
 licenses: []
 post_install_message: 
 rdoc_options: []