Update readme

Author: kennethormandy

README.md

@@ -1,90 +1,55 @@
-Flat UI Free 2.1.1
-=======
+# harp-flat-ui
 
-Flat UI Free is licensed under a Creative Commons Attribution 3.0 Unported (CC BY 3.0)  (http://creativecommons.org/licenses/by/3.0/) and MIT License - http://opensource.org/licenses/mit-license.html. 
+> A comfortable, responsive, and functional framework built upon LESS and Bootstrap.
 
-You are allowed to use these elements anywhere you want, however we’ll highly appreciate if you will link to our website when you share them - http://designmodo.com
+## Dependencies
 
-Thanks for supporting our website and enjoy!
+* [NodeJS](http://nodejs.org/) – _Server-side JavaScript runtime_
+* [Harp](http://harpjs.com/) – _The static web server with built-in preprocessing_
 
-## Links:
+## Install
 
-+ [Demo page](http://designmodo.github.com/Flat-UI/)
-+ [Official page](http://designmodo.com/flat-free)
-+ [Premium Version of Flat UI](http://designmodo.com/flat/)
+To install Flat UI, run the following command from the root of your Harp project:
 
-## Changelog
+```bash
+harp install flat-ui
+```
 
-+ 1.0 Fixed several small IE bugs
-+ 1.1 New icons, Login screen implemented to a real HTML one. Small bug fixes and refinements.
-+ 2.0 Compatibility with Flat UI Pro (Less instead of Sass), Bootstrap upgraded to 2.3.1, grids refinements, various Less compiler bugfixes, Video module bugfix, various small bugfixes.
-+ 2.1 Bootstrap upgraded to 3.0, better box model, update html5 video player to version 4.1, added components documentation and sturt-up template, various small bugfixes.
-+ 2.1.1 Typography improved (new global variables, padding and margins changed for basic elements, global default font-size now is 18px, with a line-height of 1.722, added support for <abbr>, <address>, <code>, <pre>, right-aligned <blockquote>), Buttons module completely rewritten (new global variables, buttons now require a .btn-default for the standard version, added support for .btn-link), fixed some bugs in .navbar, mixins updated (added standard mixins from Bootstrap 3), layout updated for stylized select and dropdown menu, various small bugfixes.
+Your project will look something like this…
 
-## Authors
+```
+myproject/                  <-- your project root (or public dir if in framework-mode)
+  |- components/            <-- harp puts components here
+  |   +- harp-flat-ui/      <-- where this lib gets installed
+  |       …
+  |- main.less              <-- where you reference Bootstrap 
+  +- index.jade             <-- where you reference main.css
+```
 
-**Sergey Shmidt**
+## Link
 
-+ [http://shmidt.in](http://shmidt.in)
-+ [http://twitter.com/monstercritic](http://twitter.com/monstercritic)
+Now, from within a `.less` file in your project, you can `@import` Bootstrap and Flat UI:
 
-**Sergii Iurevych**
+```less
+@import "components/harp-bootstrap/less/_bootstrap.less";
+@import "components/harp-bootstrap/less/_flat-ui.less";
+```
 
-+ [http://twitter.com/iurevych](http://twitter.com/iurevych)
-+ [http://github.com/iurevych](http://github.com/iurevych)
+Or, just a portion of Bootstrap:
 
-## Typeface
-Flat UI Free is made using the Lato typeface, which can be downloaded for free here: http://www.google.com/webfonts/specimen/Lato
+```less
+@import "components/harp-bootstrap/less/_variables.less";
+@import "components/harp-bootstrap/less/_mixins.less";
+@import "components/harp-bootstrap/less/_grid.less";
+```
 
-##Useful Links (How To)
+## Resources
 
-How to Use UI Kits, Beginners Video Tips:                 [http://designmodo.com/how-to-use/](http://designmodo.com/how-to-use/)
+* [Harp documentation](http://harpjs.com/docs)
+* [LESS documentation](http://lesscss.org)
+* [Bootstrap documentation](http://getbootstrap.com)
+* [Flat UI demo](http://designmodo.github.com/Flat-UI/)
 
+## License
 
-UI Kit Benefits:											                    [http://designmodo.com/benefits/](http://designmodo.com/benefits/)
-
-
-Create a Website using UI Packs (PSD to HTML) – Day 1: 		[http://designmodo.com/create-website-day-1](http://designmodo.com/create-website-day-1)
-
-Create a Website using UI Packs (PSD to HTML) – Day 2: 		[http://designmodo.com/create-website-day-2](http://designmodo.com/create-website-day-2)
-
-Create a Website using UI Packs (PSD to HTML) – Day 3: 		[http://designmodo.com/create-website-day-3](http://designmodo.com/create-website-day-3)
-
-Create a Website Design using The Bricks UI:				      [http://designmodo.com/website-design-bricks-ui/](http://designmodo.com/website-design-bricks-ui/)
-
-What is UI Kit and Why You Should Use it: 					      [http://designmodo.com/ui-kit-use](http://designmodo.com/ui-kit-use)
-
-How Companies can Save Time and Money Using UI Kits:		  [http://designmodo.com/save-time-money-using-ui-kits](http://designmodo.com/save-time-money-using-ui-kits)
-
-UI Kits for Developers – Prototyping and Homemade Design:	[http://designmodo.com/ui-kits-developers](http://designmodo.com/ui-kits-developers)
-
- 
-Our Shop:
-
-[http://designmodo.com/shop/](http://designmodo.com/shop/)
-
-
-Tutorials:
-
-[http://designmodo.com/tutorials/](http://designmodo.com/tutorials/)
-
-
-Freebies:
-
-[http://designmodo.com/freebies/](http://designmodo.com/freebies/)
-
-
-Affiliate Program (earn money): 
-
-[http://designmodo.com/affiliates/](http://designmodo.com/affiliates/)
-
-
-Social Media:
-
-Twitter: [http://www.twitter.com/designmodo](http://www.twitter.com/designmodo)
-
-Facebook: [http://www.facebook.com/designmodo](http://www.facebook.com/designmodo)
-
-RSS: [http://feeds.feedburner.com/designmodo](http://feeds.feedburner.com/designmodo)
-
-Google+: [https://www.google.com/+DesignModo](https://www.google.com/+DesignModo)
+This component is [Flat UI](https://github.com/designmodo/Flat-UI), which is MIT and Creative Commons Attribution 3.0 Unported licensed.

component.json

@@ -1,7 +1,7 @@
 {
   "name": "flat-ui",
   "repo": "harp/flat-ui",
-  "description": "For Harp. A comfortable, responsive, and functional framework built upon Bootstrap.",
+  "description": "For Harp. A comfortable, responsive, and functional framework built upon LESS and Bootstrap.",
   "version": "2.1.1",
   "keywords": ["harp", "less", "bootstrap", "flatui"],
   "dependencies": {