From dbdf4838997cada59ae2c9b0223052240d059a43 Mon Sep 17 00:00:00 2001 From: Kyle Neath Date: Fri, 2 Dec 2011 19:41:48 -0800 Subject: [PATCH] More README tweaks --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e9fb3be..92930d9 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,34 @@ Inspired by [TomDoc](http://tomdoc.org), KSS attempts to provide a methodology f ### New here? * **[The Spec (What KSS is)](https://github.com/kneath/kss/blob/master/SPEC.md)** -* **[Example KSS](https://github.com/kneath/kss/blob/master/test/fixtures/scss/buttons.scss)** * **[Example living styleguide](https://github.com/kneath/kss/tree/master/example)** ## Spec -To learn the methodology and ideas behind Knyle Style Sheets, you should read [SPEC.md](https://github.com/kneath/kss/blob/master/SPEC.md). It contains the documenting syntax and styleguide guidelines. +To learn the methodology and ideas behind Knyle Style Sheets, you should read [SPEC.md](https://github.com/kneath/kss/blob/master/SPEC.md). It contains the documenting syntax and styleguide guidelines. At it's core, KSS is a documenting syntax for CSS: + +```scss +// A button suitable for giving stars to someone. +// +// .star-given - A highlight indicating you've already given a star. +// .disabled - Dims the button to indicate it cannot be used. +// +// Styleguide 2.2.1. +a.button.star{ + display:inline-block; + + .star{ font-size:10px; } + + &.star-given{ + color:#ae7e00; + } + + &.disabled{ + opacity:0.5; + } +} +``` + ## Ruby Library