From a3cb118d6ab2705f0791f747ace55d350057d478 Mon Sep 17 00:00:00 2001 From: Jack Lukic Date: Thu, 9 May 2013 14:12:07 -0300 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 984e2e79c..3773b06a4 100755 --- a/README.md +++ b/README.md @@ -2,10 +2,7 @@ Semantic is a set of specifications for sharing UI elements between developers. Semantic is also a UI library to make front end development simpler and easier to learn. -## About -Semantic's goal is to define a vocabulary for interface elements based on consensus, and convention. - -For developers, this means defining class names for UI elements, outlining states that an elements can exist, and listing common ways different types of an element can be described. +## The Library ### Getting Started @@ -25,13 +22,28 @@ If you prefer to download the whole kit and kaboodle you can grab that as well. ## The Specification -The aim of the semantic specification is to create conventions for structuring and naming code for describing interface elements. +The aim of the semantic specification is to create conventions for structuring and naming code for describing interface elements. By defining a vocabulary for interface elements based on consensus, and convention, we can increase portability of UI design. + +### What it defines + +**For all ui**: Defines class name and html structures which can be used to represent an element + +**For elements**: Outlines states that an elements can exist, lists common types, or variations, of an element, and if necessary, defines how the element functions in groups. + +**For collections**: Defines a list of elements that it can include, and ways which variations in the collection can affect each element. + +**For modules**: Defines a set of behaviors the module is expected to perform. + +**For views**: Defines the types of content it usually contains, and a standard heirarchy for presenting the content to the user. + + +### How it is defined -### Based on class +#### Based on class Semantic is based on class names, instead of tags. This means, except for links, tables and form elements, you can use semantic with tags like ``
``` -### Defining UI +#### Example Here is part of Semantic's definition of a button