README.mdown in grid-coordinates-1.1.4 vs README.mdown in grid-coordinates-1.1.5

- old
+ new

@@ -1,87 +1,80 @@ # Grid Coordinates -## Sass based CSS Grid Framework Generator (Compass Extension) +## A Sass based CSS Grid Framework Generator -Grid Coordinates is a Highly configurable [Sass](http://sass-lang.com/) based CSS Grid Framework Generator delivered as a [Compass](http://compass-style.org/) extension inspired by the [1kb CSS Grid](http://1kbgrid.com/) project by [Tyler Tate](http://twitter.com/tylertate). +Grid Coordinates is a highly configurable [Sass](http://sass-lang.com/) based CSS Grid Framework Generator, inspired by [960 Grid System](http://960.gs/) and [1kb CSS Grid](http://1kbgrid.com/). Grid Coordinates takes the "coordinates" (total columns, grid width, gutter width) and generates the styles required for your grid. -## Just the grid please. +Grid Coordinates can be used as a [Compass](http://compass-style.org/) [extension](http://compass-style.org/help/tutorials/extensions/) and is delivered as a [Ruby gem](http://rubygems.org/gems/grid-coordinates). -Grid Coordinates is quite simple. It's just a grid. And it is able to generate styles for grids of any size - you control the coordinates and it generates the styles. +## Just the grid -It fully leverages classes, extends and mixins (if that's your preference) to set up the styles for your grid. It supports nested grids, prefix and suffix grid features as well as push and pull grid features. +Grid Coordinates does one job - provide a rock solid grid framework. It's able to generate styles for grids of any size - you control the coordinates and it generates the styles. +It fully leverages classes, extends and mixins to set up the styles for your grid. It supports nested grids, prefix and suffix grid features as well as push and pull grid features. + ## Installation `gem install grid-coordinates` Then add `require 'grid-coordinates'` to your Compass config file. ## Usage -Grid-coordinates defaults to create a 960 pixel grid with 12 columns and a 60px gutter. You can override these defaults in your project if this grid doesn't suit your needs. +Grid Coordinates defaults to a 960px grid with 12 columns and a 60px gutter (perfect for fans of 960.gs). You can override these defaults in your project if this grid doesn't suit your needs. -Use [1kbgrid.com](http://1kbgrid.com) or another grid generator for guidance on configuring your grid's settings. +Use the [variable grid system](http://grids.heroku.com/) to plot the course for your CSS grid. The coordinates generated are based on the 960 Grid System, which is one point of inspiration for Grid Coordinates. Take a peek at [grid-coordinates.com/.../demo.sass](https://github.com/adamstac/grid-coordinates.com/blob/master/themes/grid-coordinates/sass/demo.sass) for a demonstration of how to use Grid Coordinates as well its [output CSS](https://github.com/adamstac/grid-coordinates.com/blob/master/themes/grid-coordinates/public/grid-coordinates/css/demo.css). ### Configure as needed and import // Configure grid coordinates - $grid-columns: 24 + $grid-columns: 12 $grid-width: 60px - $grid-gutter-width: 10px - // Set to true by default. Can be set to false to clip content that overflows a grid block. - // $overflow: false + $grid-gutter-width: 20px - @import grid-coordinates + @import "grid-coordinates" - // Only needed if you're using the classes and `@extend` instead of the mixins (suggested) +grid-coordinates - - ... -The `$overflow` setting controls which of Compass' two clearfix mixins to be used, `+clearfix` or `+pie-clearfix`. The default setting is set to `true` and will not clip any content that overflows a grid block. If for some reason you need to clip overflowing content update this setting to `false`. +You can also set `$overflow` to false (set to true by default) to control which of Compass' two clearfix mixins will be used, `+clearfix` or `+pie-clearfix`. The default setting is `true` and will not clip any content that overflows a grid block. If for some reason you need to clip overflowing content, set `$overflow` to false in your configuration. ### Using classes and `@extend` -When you use the mixin `+grid-coordinates` you are able to leverage the classes in your HTML or use the Sass `extend` option to "extend" the classes in your Sass stylesheets. +When you use the mixin `+grid-coordinates` (as shown above) you are able to leverage the CSS class selectors in your HTML markup or use the Sass `extend` option to "extend" the class selectors in your Sass stylesheets. -For an example of this in use, take a peek at [grid-coordinates.com/.../demo.sass](https://github.com/adamstac/grid-coordinates.com/blob/master/themes/grid-coordinates/sass/demo.sass). +For an example of this in use, look at [grid-coordinates.com/.../demo.sass](https://github.com/adamstac/grid-coordinates.com/blob/master/themes/grid-coordinates/sass/demo.sass). `@extend .grid-container` `@extend .nested-grid-container` -`@extend .grid([columns])` +`@extend .grid-[columns]` -`@extend .grid-prefix([columns])` +`@extend .grid-prefix-[columns]` -`@extend .grid-prefix-margin-([columns])` +`@extend .grid-suffix-[columns]` -`@extend .grid-suffix([columns])` +`@extend .grid-push-[columns]` -`@extend .grid-suffix-margin-([columns])` +`@extend .grid-pull-[columns]` -`@extend .grid-push([columns])` - -`@extend .grid-pull([columns])` - `@extend .grid-full` -### Using the Mixins +### Using mixins -Use these mixins in your Sass stylesheets. Keep in mind that when you go the route of using mixins you are replicated much code in your output CSS. It's advised that you to learn the [Sass extend concept](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#extend) and use that method vs mixins. Your output CSS code with thank you. +Regardless if go the route of using the mixin `+grid-coordinates` (as shown above) or not, you'll have access to use these mixins in your Sass stylesheets. Keep in mind that when you go the route of using mixins, you could end up replicating a lot of code in your output CSS. Learn more about the [Sass extend concept](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#extend) to see if you should use that method or mixins. Either way, Grid Coordinates got your back. `+grid-container` `+nested-grid-container` `+grid([columns])` -`+grid-prefix([columns], [type])` +`+grid-prefix([columns])` -`+grid-suffix([columns], [type])` +`+grid-suffix([columns])` `+grid-push([columns])` `+grid-pull([columns])` \ No newline at end of file