Skip to content

Commit

Permalink
Update README; Fix typos on fuel doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Alamantus committed Feb 23, 2020
1 parent 784fa17 commit 4e9974c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
16 changes: 7 additions & 9 deletions README.md
@@ -1,13 +1,9 @@
# lighter 馃敟

[![npm](https://img.shields.io/npm/v/@alamantus/lighter.svg)](https://www.npmjs.com/package/@alamantus/lighter)
[![size](http://img.badgesize.io/https://cdn.jsdelivr.net/npm/@alamantus/lighter@latest/src/lighter.css?compression=gzip)](https://cdn.jsdelivr.net/npm/@alamantus/lighter@latest/src/lighter.css)
[![min+gzipped size](http://img.badgesize.io/https://cdn.jsdelivr.net/npm/@alamantus/lighter@latest/dist/lighter.css.gz)](https://cdn.jsdelivr.net/npm/@alamantus/lighter@latest/dist/lighter.css)
[![install size](https://packagephobia.now.sh/badge?p=@alamantus/lighter)](https://packagephobia.now.sh/result?p=@alamantus/lighter)
[![Downloads](https://img.shields.io/npm/dt/@alamantus/lighter.svg)](https://www.npmjs.com/package/@alamantus/lighter)
<a href="https://twitter.com/intent/tweet?text=World's+smallest+responsive+CSS+framework:&url=https%3A%2F%2Fgithub.com%2Falamantus%2Flit&hashtags=github&original_referer=http%3A%2F%2Fgithub.com%2F&tw_p=tweetbutton" target="_blank">
<img src="http://jpillora.com/github-twitter-button/img/tweet.png"
alt="tweet button" title="lighter"></img>
</a>

a ridiculously small responsive css framework.

Expand All @@ -29,12 +25,14 @@ fuel is an atomic css addon for lighter. Check it out at https://alamantus.githu
## Getting Started
1. Install lighter.css with one of the following:
- NPM: `npm install --save @alamantus/lighter`
- CSS3: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/alamantus/lighter@1.0.1/dist/lighter.css" />`
- CSSNext: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/alamantus/lighter@1.0.1/src/lighter.css" />`
- CSS3: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/alamantus/lighter@1.1.0/dist/lighter.css" />`
- CSSNext: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/alamantus/lighter@1.1.0/src/lighter.css" />`
2. [Read the Docs](https://alamantus.github.io/lighter/) to see usage

Note: lighter uses PostCSS to transform from CSSNext to CSS3. If you are comfortable outright using CSSNext, you can directly
include the `lighter.css` file in the src directory. Otherwise, use the `dist/lighter.css` file.
Note: lighter uses `node-sass` to transform from SCSS to CSS3. Each element of lighter and fuel is split into separate "modules"
in `src/modules`, so you can pick and choose what elements to use if you want to customize your style with Sass by `@import`ing
what you need.
There is also a CSSNext version preserved and updated from the fork from [lit](https://github.com/ajusa/lit). If you are comfortable outright using CSSNext, you can directly include the `lighter.css` file in the `src` directory. Otherwise, use the `dist/lighter.css` file.

## Supported Browsers
lighter supports most modern browsers (Chrome, Firefox, Edge, Opera) but it also has impressive support for older browsers.
Expand Down
4 changes: 2 additions & 2 deletions docs/fuel.html
Expand Up @@ -38,7 +38,7 @@ <h2 class="mb1" id="utilities">Utilities</h2>
</div>
<div id="spacing">
<h3 class="mb1">Spacing</h3> fuel uses a simple spacing system inspired by the likes of BassCSS and Tachyons.
<div class="bg-info c-white ph1 pv2">ph2 pv2</div>
<div class="bg-info c-white ph1 pv2">ph1 pv2</div>
In this example, p means padding (m means margin), h means horizontal while v means vertical, and the number at the end is the level. Levels go from 0-4.
<div class="bg-info c-white ml1 mt2">ml1 mt2</div>
This example shows off margins. For the middle selector, you use t (top), b (bottom), l (left), and r (right) to say which direction you want the margin. Margin does not have v or h as directions.
Expand All @@ -63,7 +63,7 @@ <h4 class="mb1">Alignment</h4>
<p class="card tc">tc</p>
<p class="card tr">tr</p>

<h4 class="mb1">Miscellaneous</h4>
<h4 class="mb1">Style</h4>
<p class="card bold">bold</p>
<p class="card normal">normal</p>
<p class="card light">light</p>
Expand Down

0 comments on commit 4e9974c

Please sign in to comment.