diff options
update Readme doc
2 files changed, 19 insertions, 2 deletions
| -rw-r--r-- | README.md | 18 | ||||
| -rw-r--r-- | index.html | 3 |
@@ -4,7 +4,6 @@ Spectre.css is a lightweight, responsive and modern CSS framework for faster and - lightweight and clean starting point for your project and prototype - flexbox, responsive and mobile-friendly layout - carefully designed elements -- optimized for asian fonts - built in useful components and utilities - patterns and html templates (soon) - email templates (soon) @@ -13,7 +12,22 @@ Spectre is a side project based on years of CSS development work on a large web Read [the documentation](http://picturepan2.github.io/spectre/) to learn more. -Spectre includes 3 parts: +### Getting started + +There are 3 ways to get started with Spectre CSS framework in your projects. You can either manually install or use NPM and Bower. +##### Install manually +Download the compiled and minified [Spectre CSS file](https://github.com/picturepan2/spectre/tree/master/dist). +##### Install with NPM +`$ npm install spectre.css` +##### Install with Bower +`$ bower install spectre.css` + +And include it in your website or Web app <head> part. + +`<link rel="stylesheet" href="dist/spectre.min.css" />` + +### Documentation and demos + #### Elements - [typography](http://picturepan2.github.io/spectre/#typography) - headings, paragraphs, blockquote, lists and code elements, optimized for asian fonts @@ -69,7 +69,10 @@ <ul> <li>lightweight and clean starting point for your project and prototype</li> <li>flexbox, responsive and mobile-friendly layout</li> + <li>carefully designed elements</li> <li>built in useful components and utilities</li> + <li>patterns and html templates (soon)</li> + <li>email templates (soon)</li> </ul> </section> <section class="notes text-center"> |