Permalink
Browse files

Updated readme and gemspec

  • Loading branch information...
1 parent 4a46338 commit 5f1369d8059fa25e639e01de88a73dc2c96f8c5f @sporkd committed Nov 21, 2011
Showing with 48 additions and 10 deletions.
  1. +46 −8 README.md
  2. +2 −2 compass-h5bp.gemspec
View
@@ -1,29 +1,67 @@
Compass H5bp
=========================
-A compass extension of common html5 mixins extracted from Paul Irish's Html5 Boilerplate project v2.0.
+This is a Compass extension of Html5 mixins extracted from v2 on Html5 Boilerplate
+by Paul Irish and Divya Manian. This gem provides only the CSS mixins and not the
+html or javascript templates. This makes sense because any implementations of
+Html5 Boilerplate will be specific to the language and framework it's built on.
+
+Browse [html5boilerplate.com](http://html5boilerplate.com) for the full workup.
+
+Or, you can read more about compass extensions [here](http://compass-style.org/help/tutorials/extensions/).
Installation
=========================
-In your Gemfile
+ gem install compass-h5bp
+
+Or, in your Gemfile
+
+ gem 'compass-h5bp'
-```
-gem 'compass-h5bp'
-```
+Then run
-```
-$ bundle install
-```
+ $ bundle install
Usage
=========================
+Inside your SCSS or SASS file, you first need to import the `h5bp`
+compass library before you can use any of the mixins:
+
+ @import "h5bp";
+
+Then include the mixins that make up the Normalize portion of Html5
+Boilerplate's styles. http://necolas.github.com/normalize.css
+
+ @include h5bp-display;
+ @include h5bp-base;
+ @include h5bp-links;
+ @include h5bp-typography;
+ @include h5bp-lists;
+ @include h5bp-embeds;
+ @include h5bp-figures;
+ @include h5bp-forms;
+ @include h5bp-tables;
+
+Now you can define your own custom CSS here.
+
+Then (optionally) let H5bp define some semantic helper classes. (e.g. `.clearfix`):
+
+ @include h5bp-helpers;
+
+Finally, you can include H5bp's predefined print style media query:
+
+ @include h5bp-media;
+
License
========
+HTML5 Boilerplate created by by Paul Irish and Divya Manian
+http://html5boilerplate.com
+
Copyright (c) 2011 Peter Gumeson
See [LICENSE](https://github.com/sporkd/compass-h5bp/blob/master/LICENSE) for full license.
View
@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
s.authors = ["Peter Gumeson"]
s.email = ["gumeson@gmail.com"]
s.homepage = "http://rubygems.org/gems/compass-h5bp"
- s.summary = %q{ A compass extension of common html5 mixins extracted from Html5Boilerplate v2.0 }
- s.description = %q{}
+ s.summary = %q{ Compass extension for Html5 Boilerplate v2.0 }
+ s.description = %q{ Compass extension of Html5 mixins extracted from v2 of Paul Irish's Html5 Boilerplate project }
s.rubyforge_project = "compass-h5bp"

0 comments on commit 5f1369d

Please sign in to comment.