From 557c258c471551109bae1b64e0e7ec9eb22c15a8 Mon Sep 17 00:00:00 2001 From: CJ Patoilo Date: Sat, 26 Dec 2015 18:39:19 -0300 Subject: [PATCH] updated readme --- readme.md | 379 +++--------------------------------------------------- 1 file changed, 16 insertions(+), 363 deletions(-) diff --git a/readme.md b/readme.md index f5d1278..3322adf 100644 --- a/readme.md +++ b/readme.md @@ -8,383 +8,36 @@ Milligram provides a minimal setup of styles for a fast and clean starting point. Just it! **Only 2kb gzipped!** It's not about a UI framework. Specially designed for better performance and higher productivity with fewer properties to reset resulting in cleaner code. Hope you enjoy! -## Getting Started - -There are some ways to get started. First, see all download options available below, then choose the most suitable option for your need. Now you should add the main file of the Milligram and the CSS Reset in the header of your project. Just that! - +## Download **Install with Bower** -Milligram is available to install using Bower. - ```sh $ bower install milligram ``` **Install with npm** -Milligram is also available to install using npm. - ```sh $ npm install milligram ``` -**What's included** -Once downloaded, extract the compressed folder to see the main file in the uncompressed and minified version. - -```sh -milligram/ -├── .gitignore -├── bower.json -├── component.json -├── demo/ -├── dist/ -│ ├── milligram.css -│ └── milligram.min.css -├── gruntfile.js -├── license -├── package.json -├── readme.md -├── sass/ -└── test/ -``` - -**Usage** - -First, use any method mentioned above to download Milligram. Then, just add these tags in the head. Milligram is also available via [CDN](#). - -```html - - - - - - - - - - -``` -See more examples of **getting started** [here](http://milligram.github.io/getting-started.html). - - -## Typography - -CSS3 introduces a few new units, including the `rem` unit, which stands for *"root em"*. The rem unit is relative to the font-size of the root element ``. That means that we can define a single font size on the root element, and define all `rem` units to be a percentage of that. The typography has `font-size` defined in 1.6rem (16px) and `line-height` in 1.6 (24px). Milligram uses the `font-family` [Roboto](https://www.google.com/fonts/specimen/Roboto), created by Christian Robertson, and provided by Google. - -```html - -

The base type is 1.6rem (16px) over 1.6 line height (24px)

- - -Archor -Emphasis -Small -Strong -Underline - - -

Heading

-

Heading

-

Heading

-

Heading

-
Heading
-
Heading
- - -```` - -See more examples of **typography** [here](http://milligram.github.io/typography.html). - - -## Blockquotes - -The Blockquote represents a section that is quoted from another source. - -```html -
-

Yeah!! Milligram is amazing.

-
-``` - -See more examples of **blockquotes** [here](http://milligram.github.io/blockquotes.html). - - -## Buttons - -The Button, an essential part of any user experience. Buttons come in three basic styles in Milligram: The ` - - - - - -``` - -See more examples of **buttons** [here](http://milligram.github.io/buttons.html). - - -## Lists - -The List is a very versatile and common way to display items. Milligram has three types of lists: The unordered list use `
    ` element will be marked with a outline circles, the ordered list use `