From 29e0810bce8ae914b0c049518deef6ce6365bac5 Mon Sep 17 00:00:00 2001 From: Yan Zhu Date: Thu, 14 Apr 2016 17:20:15 +0800 Subject: update Readme doc --- README.md | 18 ++++++++++++++++-- index.html | 3 +++ 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3893624..3fe47c3 100644 --- a/README.md +++ b/README.md @@ -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. + +`` + +### Documentation and demos + #### Elements - [typography](http://picturepan2.github.io/spectre/#typography) - headings, paragraphs, blockquote, lists and code elements, optimized for asian fonts diff --git a/index.html b/index.html index 92ad264..c74968c 100644 --- a/index.html +++ b/index.html @@ -69,7 +69,10 @@
-- cgit v1.3.1-26-gb76a