diff --git a/README.md b/README.md index 245bd8c..b3464e7 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,72 @@ -# Crispy - Lightweight CSS / SASS Framework +# Crispy - Lightweight CSS / SCSS Framework ## Installation ``` -npm install crispy-boilerplate +npm install crispy-css ``` -Main SCSS-File: +## How it works + +### SCSS + +``` +@import + "crispy"; +``` + +Now include Mixins you need. Components and Modifiziers only works if you include them, + +``` +@include crispy__core(); +@include crispy__modifiers(); + +// components +@include crispy__button(); +@include crispy__code(); +@include crispy__field(); +@include crispy__group(); +@include crispy__heading(); +@include crispy__hero(); +@include crispy__icon(); +@include crispy__media(); +@include crispy__modal(); +@include crispy__overlay(); +@include crispy__panel(); +@include crispy__table(); +``` + +For Custom Variables add a File before importing Crispy, ``` @import + "variables", "crispy"; ``` -After this, include Mixins you need: +If you need all, mixins will be included, ``` -@include crispy__*() +@import + "crispy_all"; ``` -To overwrite defaults simple add your own config-file after importing crispy: +Only need Core and Modifiziers? ``` @import - "crispy", - "config"; + "crispy_minimal"; ``` + +### CSS + +For using CSS you can use crispy.css for all Styles or crispy_mininmal.css without Components. + +## Example +You find an example in "/src/example", this is this Documentation. In the given example there are additional directories. These ones are part of a structure which might be helpful for you. + +### Site +Contains header, footer, partials that are used on a site or webapp. Header and Footer are not classical components, there often more complex and have a special brand. + +### Templates +Templates are for a single site or a group of sites, they are complex and there is no benefit so reuse them as components. diff --git a/dist/example/index.html b/dist/example/index.html index 14e6dae..7ec8daf 100644 --- a/dist/example/index.html +++ b/dist/example/index.html @@ -26,7 +26,7 @@
For Custom Variables add a File before importing Crispy
+For Custom Variables add a File before importing Crispy,
@import
"variables",
"crispy";
diff --git a/package.json b/package.json
index 320b043..708c2f5 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,5 @@
{
- "name": "crispy",
+ "name": "crispy-css",
"version": "2.0.0",
"description": "Flat Sass Boilerplate to give you a amount of Basic Settings, Mixins and Functions",
"repository": {
diff --git a/src/all.scss b/src/crispy_all.scss
similarity index 100%
rename from src/all.scss
rename to src/crispy_all.scss
diff --git a/src/minimal.scss b/src/crispy_minimal.scss
similarity index 100%
rename from src/minimal.scss
rename to src/crispy_minimal.scss
diff --git a/webpack.mix.js b/webpack.mix.js
index 5d391cc..7c71709 100644
--- a/webpack.mix.js
+++ b/webpack.mix.js
@@ -11,14 +11,14 @@ let mix = require('laravel-mix');
|
*/
-mix.sass('src/all.scss', 'dist/crispy.css', {
+mix.sass('src/crispy_all.scss', 'dist/crispy_all.css', {
sassOptions: {
includePaths: [
'node_modules/normalize-scss/sass'
]
}
})
- .sass('src/minimal.scss', 'dist/crispy_minimal.css', {
+ .sass('src/crispy_minimal.scss', 'dist/crispy_minimal.css', {
sassOptions: {
includePaths: [
'node_modules/normalize-scss/sass'