Summary Files Commits Branches @commit @diff @stats
diff options
context:
space:
mode:
Commit29e0810bce8ae914b0c049518deef6ce6365bac5 (patch)
Author
 Yan Zhu <picturepan2@hotmail.com>
2016-04-14 17:20:15 +0800
Committer
 Yan Zhu <picturepan2@hotmail.com>
2016-04-14 17:20:15 +0800
Files290713a5174d83e1b9ac1d7accd7224e016a6e07
Spectre-Dark-Gruvbox-29e0810bce8ae914b0c049518deef6ce6365bac5.tar
Spectre-Dark-Gruvbox-29e0810bce8ae914b0c049518deef6ce6365bac5.tar.gz
Spectre-Dark-Gruvbox-29e0810bce8ae914b0c049518deef6ce6365bac5.zip
Parent5315e19db4f015c05758904298002f29c04e7c9d (diff)
update Readme doc
2 files changed, 19 insertions, 2 deletions
-rw-r--r--README.md18
-rw-r--r--index.html3
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 &lt;head&gt; 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
diff --git a/index.html b/index.html
index 92ad264..c74968c 100644
--- a/index.html
+++ b/index.html
@@ -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">