@nrk/core-css - npm Package Compare versions

Comparing version 1.12.4 to 1.13.0

package.json

@@ -6,3 +6,3 @@ {
   "author": "NRK <[e-mail]> (https://www.nrk.no/)",
-  "version": "1.12.4",
+  "version": "1.13.0",
   "license": "MIT",
@@ -26,8 +26,8 @@ "scripts": {
   "devDependencies": {
-    "autoprefixer": "9.4.6",
+    "autoprefixer": "9.5.0",
     "postcss": "7.0.14",
-    "postcss-classes-to-mixins": "0.0.6",
+    "postcss-classes-to-mixins": "2.0.0",
     "postcss-header": "1.0.0",
-    "rollup": "1.1.2",
-    "rollup-plugin-postcss": "2.0.1",
+    "rollup": "1.8.0",
+    "rollup-plugin-postcss": "2.0.3",
     "rollup-plugin-serve": "1.0.1",
@@ -34,0 +34,0 @@ "standard": "12.0.1"

README.md

 # @nrk/core-css ![Release](https://img.shields.io/github/release/nrkno/core-css.svg)
-> Base styling and utilities for all NRK projects.
+> Base styling and utilities for all NRK projects. 
+> `@nrk/core-css` exposes a set of class names and mixins to ease creating backwards compatible layouts and standard NRK styling. The code is built on BEM-conventions and is namespaced `nrk-` to play nice with existing projects.
 
-For installation and usage, read the [documentation](https://static.nrk.no/core-css/latest/).
+## Documentation
+https://static.nrk.no/core-css/latest/
 
-## Adding fonts and icons
+## Installation
 
-In order to use NRKs core fonts and icons, see these related projects:  
-https://github.com/nrkno/core-fonts (Only available for NRK employees)
-https://github.com/nrkno/core-icons
+### Using NPM
 
-Once the fonts (*LFT Etica* and *NRK Etica Slab*) have been imported, add this to your project’s CSS:
+```sh
+npm install @nrk/core-css --save-exact
+```
+
+then import it into your stylesheet:
+
 ```css
-html {
-  font-family: 'LFT Etica', 'Helvetica Neue', Helvetica, Arial, sans-serif;
-}
+
+@import '@nrk/core-css/core-css.css';               // css
+@import '@nrk/core-css/core-css.scss';              // sass
+@import '@nrk/core-css/core-css.less';              // less
+@import 'node_modules/@nrk/core-css/core-css.styl'  // stylus
 ```
 
+### Using static
+
+Recommended only for prototyping.
+
+```html
+<link rel="stylesheet" href="https://static.nrk.no/core-css/major/1/core-css.min.css">
+```
+
 ## Local development
@@ -20,0 +35,0 @@ First clone `@nrk/core-css` and install dependencies:

No alert changes

Improved metrics

Total package byte prevSize

202435

increased by84.66%

Number of package files

18

increased by50%

Lines of code

86

increased by2.38%

Number of lines in readme file

58

increased by34.88%

No dependency changes