diff --git a/README.md b/README.md index 92734d4..b82e4f9 100644 --- a/README.md +++ b/README.md @@ -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 `` tag: - \ No newline at end of file + + +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). \ No newline at end of file