@vtmn/css-rating - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "@vtmn/css-rating",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Decathlon Design System - Vitamin specific CSS styles for rating component",
@@ -25,3 +25,3 @@ "keywords": [
   "scripts": {
-    "build": "postcss src/index.css -o dist/index.css && cross-env FONT_SIZE_BASE=10 postcss src/index.css -o dist/index-base10.css"
+    "build": "sh build.sh"
   },
@@ -42,3 +42,3 @@ "devDependencies": {
   ],
-  "gitHead": "c7c73c0f32bb69a220a0d79521461b951d722af2"
+  "gitHead": "315d73a2d785e225efae90c7577f47fafeb8c315"
 }

README.md

@@ -72,6 +72,10 @@ # `@vtmn/css-rating`
 
-## Usage
+# Usage
 
 Once you have installed this package, you just have to import CSS styles!
 
+### Without theming
+
+If you don't need different themes, you can choose the specific CSS package without CSS variables.
+
 With a bundler that supports CSS imports in JS files:
@@ -89,2 +93,40 @@
 
+### With theming
+
+If you need different themes, you can choose the specific CSS package with CSS variables. For this, be sure to install & import `@vtmn/css-design-tokens` before:
+
+```sh
+# with npm
+npm i -S @vtmn/css-design-tokens
+
+# with yarn
+yarn add @vtmn/css-design-tokens
+```
+
+Or you can also install it with a CDN like `unpkg.com`:
+
+```html
+<link rel="stylesheet" href="https://unpkg.com/@vtmn/css-design-tokens" />
+```
+
+With a bundler that supports CSS imports in JS files:
+
+```javascript
+import '@vtmn/css-design-tokens/dist/index.css';
+import '@vtmn/css-rating/dist/index-with-vars.css';
+```
+
+Otherwise include it in your HTML file:
+
+```html
+<link
+  rel="stylesheet"
+  href="./node_modules/@vtmn/css-design-tokens/dist/index.css"
+/>
+<link
+  rel="stylesheet"
+  href="./node_modules/@vtmn/css-rating/dist/index-with-vars.css"
+/>
+```
+
 ## Development
@@ -91,0 +133,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

44402

increased by52.77%

Number of package files

7

increased by40%

Lines of code

540

increased by106.11%

Number of lines in readme file

157

increased by36.52%

No dependency changes