README.md in stitch-0.0.3 vs README.md in stitch-0.1.0
- old
+ new
@@ -1,6 +1,6 @@
-# Stitch CSS Pattern Framework
+# Stitch - CSS Pattern Framework for Compass
Patterns are chunks of styles that we use on every project. These chunks of styles generally perform a particular function, such as clearing floats. Having to write these styles each time is annoying and the function of these chunks of code in our stylesheets is obscure.
By breaking these patterns into reusable classes and mixins we:
@@ -8,79 +8,35 @@
* Give our styles more meaning
* Reduce the size of our stylesheet
* Only have to write them once
* Are updatable when newer methods are discovered by updating the framework
-# Get Stitch
+## Get Stitch
-Install the Rubygem.
-
- gem install stitch
+ sudo gem install stitch
-# Create a new project
+## Add it to your Compass config.rb
-Now create your bare project that includes compass-stitch:
+ require 'stitch'
- compass create my-project --bare -r stitch
-
-Install the project template:
+## Import it into your Sass
- compass install stitch/project
+ @import 'stitch';
-# Add Stitch to a current project
+## Or import it in parts
-To add Stitch patterns to a current project, add this to the top of your stylesheets
-
+ @import 'stitch/reset';
@import 'stitch/patterns';
-
-And in your Compass config.rb file add
-
- require 'compass-stitch'
-
-To use the project template layout, run
- compass install stitch/project
+## Patterns
-and the project template will be installed into your current directory
-
-# Patterns
-
[See all of the patterns available](https://github.com/anthonyshort/stitch-css/tree/master/stylesheets/stitch/patterns)
-By using @import 'stitch/patterns'; you will have access to all of the pattern mixins.
+By using @import 'stitch/patterns'; you will have access to all of the pattern mixins. The patterns are all mixins with a couple of extra classes used for extending.
-# Reset
+## Reset
-Stitch includes a CSS reset. This is a new reset I'm working on. It resets everything back to it's raw text form so that it's easy to build from.
+Stitch includes a unique CSS reset. It resets everything back to it's raw text form so that it's easy to build from.
To manually import the Stitch reset.
- @import 'stitch/reset/desktop';
-
-If you're using the Stitch project template, this will be included for you.
-
-Stitch only includes a [desktop reset](https://github.com/anthonyshort/stitch-css/blob/master/stylesheets/stitch/patterns/reset/_desktop.scss) for now.
-
-# Project Template
-
-This project folder sets up the conventions for laying out your stylesheets. It is built around the idea that a single site may have many layouts and we'll use media queries to select which layout to use.
-
-However, we don't want to ALWAYS use media queries, so we still have the option to import the layouts statically.
-
-There are two files, master.scss and legacy.scss. Master imports the layouts based on media queries:
-
- // Default Layout
- @import "layouts/desktop/master.css" screen and (min-width: 481px);
-
- // Adjusted default layout for smaller tablet screens
- @import "layouts/tablet/master.css" screen and (min-width: 481px) and (max-width: 1024px);
-
- // Adjusted layout for mobile devices
- @import "layouts/mobile/master.css" screen and (max-width: 480px);
-
-Whereas the legacy file will import files statically and without media queries. This means we can send the legacy file to browsers that don't support media queries, and we can send the master file to browsers that do.
-
-## Assets Folder
-
-This folder is where the majority of your assets, such as fonts and images, will live. Keeping them in this single spot makes them easy to access from any layout.
-
-Assets can include a stylesheet that allows layouts to easily use them. In the case of fonts, a stylesheet should be included with the @font-face method so that layouts only need to import the stylesheet to use the assets. The same method could be used for backgrounds, icons etc.
+ @import 'stitch/reset';
\ No newline at end of file