Permalink
Browse files

README changes again

  • Loading branch information...
1 parent c421646 commit 75503907436727ce07a6aa5b70737a60a0420d65 @rstacruz committed Oct 13, 2009
Showing with 36 additions and 26 deletions.
  1. +36 −26 README.md
View
@@ -1,23 +1,21 @@
Sparkup
=======
-Install this by putting `sparkup` in your `$PATH` somewhere. Requires Python 2.5+ (comes
-preinstalled with Mac OS X).
+**Sparkup lets you write HTML code faster.** Don't believe us?
+[See it in action!](http://www.youtube.com/watch?v=Jw3jipcenKc)
-This project is inspired by [Zen Coding](http://code.google.com/p/zen-coding/) of
-[Vadim Makeev](http://pepelsbey.net). The Zen HTML syntax is forward-compatible with Sparkup
-(anything that Zen HTML can parse, Sparkup can too).
+You can write HTML in a CSS-like syntax, and have Sparkup handle the expansion to full HTML
+code. It is meant to help you write long HTML blocks in your text editor by letting you
+type less characters than needed.
-Usage
------
+Sparkup is written in Python, and requires Python 2.5 or newer (2.5 is preinstalled in
+Mac OS X Leopard). Sparkup also offers intregration into common text editors. Support for VIM
+and TextMate are currently included.
-You can write HTML in a CSS-like syntax, and have `sparkup` handle the expansion to full code.
-To use `sparkup` in the command line, simply do `echo "<your code here>" | sparkup`.
+A short screencast is available here:
+[http://www.youtube.com/watch?v=Jw3jipcenKc](http://www.youtube.com/watch?v=Jw3jipcenKc)
-Sparkup also offers intregration into common text editors. Support for VIM and TextMate are
-currently included.
-
-Usage for text editors
+Usage and installation
----------------------
- **TextMate**: Simply double-click on the `Sparkup.tmbundle` package in Finder. This
@@ -27,63 +25,75 @@ Usage for text editors
- **VIM**: See the `sparkup.vim` file's contents for details.
+ - **Others/command line use**: You may put `sparkup` in your `$PATH` somewhere. You may then
+ invoke it by typing `echo "(input here)" | sparkup`, or `sparkup --help` for a list of commands.
+
+Credits
+-------
+
+Sparkup is written by Rico Sta. Cruz and is released under the MIT license.
+
+This project is inspired by [Zen Coding](http://code.google.com/p/zen-coding/) of
+[Vadim Makeev](http://pepelsbey.net). The Zen HTML syntax is forward-compatible with Sparkup
+(anything that Zen HTML can parse, Sparkup can too).
+
Examples
--------
-**div**
+**`div`** expands to:
<div></div>
-**div#header**
+**`div#header`** expands to:
<div id="header"></div>
-**div.align-left#header**
+**`div.align-left#header`** expands to:
<div id="header" class="align-left"></div>
-**div#header + div#footer**
+**`div#header + div#footer`** expands to:
<div id="header"></div>
<div id="footer"></div>
-**#menu > ul**
+**`#menu > ul`** expands to:
<div id="menu">
<ul></ul>
</div>
-**#menu > h3 + ul**
+**`#menu > h3 + ul`** expands to:
<div id="menu">
<h3></h3>
<ul></ul>
</div>
-**#header > h1{Welcome to our site}**
+**`#header > h1{Welcome to our site}`** expands to:
<div id="header">
<h1>Welcome to our site</h1>
</div>
-**a[href=index.html]{Home}**
+**`a[href=index.html]{Home}`** expands to:
<a href="index.html">Home</a>
-**ul > li*3**
+**`ul > li*3`** expands to:
<ul>
<li></li>
<li></li>
<li></li>
</ul>
-**ul > li.item-$*3**
+**`ul > li.item-$*3`** expands to:
<ul>
<li class="item-1"></li>
<li class="item-2"></li>
<li class="item-3"></li>
</ul>
-**ul > li.item-$*3 > strong**
+**`ul > li.item-$*3 > strong`** expands to:
<ul>
<li class="item-1"><strong></strong></li>
<li class="item-2"><strong></strong></li>
<li class="item-3"><strong></strong></li>
</ul>
-**table > tr*2 > td.name + td*3**
+**`table > tr*2 > td.name + td*3`** expands to:
<table>
<tr>
<td class="name"></td>
@@ -99,7 +109,7 @@ Examples
</tr>
</table>
-**#header > ul > li < p{Footer}**
+**`#header > ul > li < p{Footer}`** expands to:
<!-- The < symbol goes back up the parent; i.e., the opposite of >. -->
<div id="header">
<ul>

0 comments on commit 7550390

Please sign in to comment.