diff --git a/README.md b/README.md index f4701398..898683e1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # Harp ----------------- -Harp is an open source Asset Pipeline Framework (aka Static Site Generator) for rapidly building responsive HTML5 applications. What makes Harp unique is that it has a Platform built from the ground up for hosting Harp applications (through Dropbox no less). See [harp.io](http://harp.io) for more details. +> Harp is an open source Asset Pipeline Framework for developing Front-End applications. + +What is an Asset Pipeline Framework you ask? An Asset Pipeline Framework offers the best +tradeoffs between Static Site Generator (such as Jekyll) and a Full Stack Framework such +as (Ruby on Rails / ExpressJS). Harp automatically translates Stylus and Less to CSS. Harp +also allows you to write your markup with Jade and Markdown. + +### -What is an Asset Pipeline Framework you ask? An Asset Pipeline Framework offers the best tradeoffs between Static Site Generator (such as Jekyll) and a Full Stack Framework such as (Ruby on Rails). It compiles to static assets but has some runtime functionality that SSGs typically don't have (such as redirects and auth). The asset pipeline is first-class requiring no configuration to get started. ## Table of Contents @@ -25,7 +30,7 @@ What is an Asset Pipeline Framework you ask? An Asset Pipeline Framework offers ### Features - - **asset pipeline** - built-in asset pipeline for seamlessly serving of [jade](http://jade-lang.com/) and [less](http://lesscss.org/) files. + - **asset pipeline** - built-in asset pipeline for seamlessly serving of [jade](http://jade-lang.com/) [markdown](http://daringfireball.net/projects/markdown/), [stylus](http://learnboost.github.io/stylus/), and [less](http://lesscss.org/) files. - **layouts and partials** - the beloved layout/partial templating paradigm you know and love. - **global variables** - specify global variables to be available in all your templates. - **selected state** - a `current` object is available in all your templates for determining the current page. @@ -45,12 +50,10 @@ Maintained by [@sintaxi](http://twitter.com/sintaxi). Made for the [@HarpPlatfor Creating a new harp application is a breeze... - mkdir myproj; cd myproj - harp init - -Now lets spin up the server and view the project at http://localhost:9966 - + harp init myproj; cd myproj harp server + +Your Harp application is now running at http://localhost:9966 ## The Rules @@ -227,7 +230,7 @@ Please keep your branch up to date by rebasing upstream changes from master. ### New Functionality -If you wish to add new functionality to harp, please provide [@sintaxi](mailto:brock@sintaxi.com) a harp application that demonstrates deficiency in current design or desired additional behaviour. Optionally, you may submit a pull request with the steps above. +If you wish to add new functionality to harp, please provide [@sintaxi](mailto:brock@sintaxi.com) a harp application that demonstrates deficiency in current design or desired additional behaviour. You may also submit a pull request with the steps above. ## License