beenull/mini.css
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated README

Browse source
This commit is contained in:
Angelos Chalaris 2016-09-21 13:38:55 +03:00
parent e4690d8d15
commit 2e43bfe76f
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -3,8 +3,22 @@
![Demo page](/docs/demo.png)
## Usage
You can learn all about using it, its modules and components, as well as see a live demo [here](https://chalarangelo.github.io/mini.css/).
## Setup
To give **mini.css** a try using the default flavor, paste the following code inside your HTML page's `<head>` tag:
<link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/master/flavors/mini-default.min.css">
<link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/master/flavors/mini-default.min.css">
Alternatively, you can use one of the other [flavors](https://github.com/Chalarangelo/mini.css/tree/master/flavors). Simply replace the final part of the URL with the flavor's CSS file (minified or not) and you're good to go!
## Customization
If you want to develop your own flavor or tweak an existing one, head over to the [SCSS](https://github.com/Chalarangelo/mini.css/tree/master/scss) folder, grab all the files and open the [flavor.scss](https://github.com/Chalarangelo/mini.css/blob/master/scss/flavor.scss) file to start building your own flavor.
If you want to know all about the framework, the mixins and the variables, check the [wiki](https://github.com/Chalarangelo/mini.css/wiki).
## License
The project is licensed under the [MIT License](https://github.com/Chalarangelo/mini.css/blob/master/LICENSE).