Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Alamantus committed Nov 30, 2021
1 parent 348b8e3 commit 39ddf10
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
16 changes: 10 additions & 6 deletions README.md
Expand Up @@ -25,9 +25,12 @@ 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.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
- CSS3: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/alamantus/lighter@1.2.0/dist/lighter.css" />`
- CSSNext: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/alamantus/lighter@1.2.0/src/lighter.css" />`
2. (Optional) Add fuel.css if you want more:
- CSS3: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/alamantus/lighter@1.2.0/dist/fuel.css" />`
- CSSNext: `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/alamantus/lighter@1.2.0/src/fuel.css" />`
3. [Read the Docs](https://alamantus.github.io/lighter/) to see usage

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
Expand All @@ -41,6 +44,7 @@ lighter has been tested on Internet Explorer 11 with no issues.
## Development Setup
1. Clone this repository (https://www.github.com/alamantus/lighter)
2. Make sure you have [npm](https://www.npmjs.com/get-npm) installed
3. Run `npm install` in the root directory of `lighter`
4. Once that is completed, run `npm run build` to build the minified version and the gzipped file.
5. If you are making changes live, use `npm run watch`. `watch` will build the minified css file in `./dist` whenever there is a change in `./src/lighter.css`.
3. (for Windows) Install `windows-build-tools` so you can install stuff
4. Run `npm install` in the root directory of `lighter`
5. Once that is completed, run `npm run build` to build the minified version and the gzipped file.
6. If you are making changes live, use `npm run watch`. `watch` will build the minified css file in `./dist` whenever there is a change in `./src/lighter.css`.
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "@alamantus/lighter",
"version": "1.2.0",
"version": "1.2.1",
"description": "a ridiculously small css framework",
"main": "lighter.css",
"scripts": {
Expand Down

0 comments on commit 39ddf10

Please sign in to comment.