diff --git a/README b/README index d61c006a..3e9cc499 100644 --- a/README +++ b/README @@ -1,4 +1,79 @@ -Haml -==== += HAML (XHTML Abstraction Markup Language) -Description goes here \ No newline at end of file +HAML is a markup language that is used to cleanly and simply describe the XHTML +of any web document without the use of inline code. HAML functions as a +replacement for inline page templating systems such PHP, RHTML, and ASP. +However, HAML avoids the need for explicitly coding XHTML into the template, +because it iself is a description of the XHTML, with some code to generate +dynamic content. + +== Features + +* Whitespace Active +* Well-formatted XHTML +* DRY +* Follows styles common in CSS + +== Using HAML as a Rails plugin + +Write Rails templates with the .haml extension. Example: + + %html + %head + %title= "Teen Wolf (1985)" + %body + #contents + %h1 "A highschooler discovers that he is a werewolf" + %ul.cast + %li "Scott Howard" + %li "Rupert 'Stiles' Stilinski" + %li "Lisa 'Boof' Marconi" + %li "Lewis" + +Would result in this XHTML: + + +
+