From 7220f411e4d15854d9182344cd5a89f98ce896f4 Mon Sep 17 00:00:00 2001 From: Pascal Kleindienst <mail@pascalkleindienst.de> Date: Mon, 24 Oct 2016 15:15:48 +0200 Subject: [PATCH] added readme --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7103478 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# consola.css + +consola.css is a lightweight CSS micro-framework for a console like style. +It is very minimalistic and has therefore a small footprint *(only **3.78 kB gzipped**)* + + It's also in SCSS and CSS and comes with a gulpfile for customizing the build. + + ## Installation + Via bower + ``` + $ bower install --save consola.css + ``` + +Via npm + ``` + $ npm install --save consola.css + ``` + +### Using the SCSS + +In your SCSS file, you can import consola.css: + +```scss +@import "/path/to/consola.css/scss/consola"; +``` + +Variables are stored in the `scss/_variables.scss` file, so they can be easily customized: +```scss +$font-size: 14px; +$red: #ff0000; + +@import "/path/to/consola.css/scss/consola"; +``` + +### Using the CSS +Just add a `<link>` in your `<head>` of either `consola.css` or +the minified version `consola.min.css`. + +## License +MIT License - Copyright (c) 2016 Pascal Kleindienst + +See [LICENSE](LICENSE) for full license description + +## Credits +* [Normalize](http://necolas.github.io/normalize.css) for the foundation. +* [Flexboxgrid](https://github.com/kristoferjoseph/flexboxgrid) for the grid style.