sass-planifolia

commit

bd21c56d941c2410962128c484e752717faceab9

parent

6af2ef6210f8cee97f6efb71e2baf83604de892b

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2017-12-22 14:20

update README

Diffstat

1 files changed, 31 insertions, 26 deletions

diff --git a/README.md b/README.md

@@ -1,44 +1,49 @@
    1     1 Sass-Planifolia - Vanilla Sass helper functions
    2     2 
    3    -1 [Sass](http://sass-lang.com/) is great, but some of its libraries not so much.
    4    -1 [Compass](http://compass-style.org/), the most popular of them all, seems to be
    5    -1 unmaintained. In addition, the rise of [libSass](http://sass-lang.com/libsass)
    6    -1 means that ruby extensions are no longer a good way forward.
   -1     3 [Compass](http://compass-style.org/) was great, but it has been unmaintained
   -1     4 for a while now. In addition, the rise of
   -1     5 [libSass](http://sass-lang.com/libsass) means that ruby extensions are no
   -1     6 longer a good way forward.
    7     7 
    8    -1 Planifolia is a collection of high-quality implementations of common framework
    9    -1 functionality. It does not depend on a specific implementation of the Sass
   10    -1 compiler.
   -1     8 Planifolia is a collection of commonly used helper functions.  It does not
   -1     9 depend on a specific implementation of the Sass compiler.
   -1    10 
   -1    11 The following modules are included:
   -1    12 
   -1    13 -   **math** for high performance math functions
   -1    14 -   **contrast** for WCAG compatible [color
   -1    15     contrast](https://www.w3.org/TR/WCAG20/#contrast-ratiodef) functions
   -1    16 -   **color** for CIELAB/CIELUV based color functions (with support for
   -1    17     [HSLuv](http://www.hsluv.org/))
   -1    18 -   **clearfix** for compass compatible clearfix mixins
   -1    19 -   **grid** for simple grid mixins
   -1    20 
   -1    21 These modules can be imported individually (color depends on math though).
   -1    22 Also note that these modules will only define mixins and variables. They will
   -1    23 not output any CSS. This means that importing them does not add a single byte
   -1    24 to your CSS.
   -1    25 
   -1    26 See the [full documentation](https://xi.github.io/sass-planifolia/) for more
   -1    27 details.
   11    28 
   12    29 # Quick start
   13    30 
   14    -1     bower install xi/sass-planifolia
   -1    31     npm install sass-planifolia
   15    32 
   16    33 Import it in your Sass files:
   17    34 
   18    -1     @import "bower_components/sass-planifolia/sass/math";
   19    -1     @import "bower_components/sass-planifolia/sass/contrast";
   -1    35     @import "node_modules/sass-planifolia/sass/math";
   -1    36     @import "node_modules/sass-planifolia/sass/contrast";
   -1    37     @import "node_modules/sass-planifolia/sass/color";
   20    38 
   21    39     .test {
   22    -1         background: red;
   -1    40         background-color: red;
   23    41         color: contrast-color(red);
   -1    42         border-color: contrast-stretch(red, orange);
   -1    43         box-shadow: 0 0 1em pf-shade(red, 0.5, 'lab');
   24    44         font-size: 16px * pow(2.3, 1.5);
   25    45     }
   26    46 
   27    -1 # Features
   28    -1 
   29    -1 -   Does not depend on a specific Sass implementation
   30    -1 -   Leightweight
   31    -1 -   Unit tests
   32    -1 -   [Fully documented](https://xi.github.io/sass-planifolia/)
   33    -1 -   High performance math algorithms
   34    -1 -   WCAG compatible [color
   35    -1     contrast](https://www.w3.org/TR/WCAG20/#contrast-ratiodef) functions
   36    -1 -   CIELAB/CIELUV based color functions (with support for
   37    -1     [HSLuv](http://www.hsluv.org/))
   38    -1 -   More functionality may be added on demand.
   39    -1 -   Can be installed with bower or npm (eyeglass). Other options may be added
   40    -1     on demand.
   41    -1 
   42    47 # What is not included?
   43    48 
   44    49 -   Vendor prefixes, polyfills or browser hacks. There are plenty of librariers