@carbongos/style-guide - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
 	"name": "@carbongos/style-guide",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"description": "Defines the style guide for use across Carbongos products.",
-	"main": "colours.scss",
+	"main": "styles/index.scss",
 	"scripts": {
@@ -7,0 +7,0 @@ "test": "echo \"Error: no test specified\" && exit 1"

README.md

 # Style Guide
 Defines the style guide for use across Carbongos products.
 
-## Colours
-Our brand colours are defined in `colours.scss`.
+## Style
 
+### Colours
+Our brand colours are defined in `styles colours.scss`.
+
 ## NPM & Deployment
-This project automatically publishes to npm here: https://www.npmjs.com/package/@carbongos/style-guide on merge into the master branch. (See `.github/workflows/publish.yml`).
+This project automatically publishes to npm here: https://www.npmjs.com/package/@carbongos/style-guide on merge into the master branch. (See `.github/workflows/publish.yml`).
+
+### Usage
+1. install the package
+```bash
+npm i -S @carbongos/style-guide
+```
+
+2. import inside of an scss block
+```scss
+@import '@carbongos/style-guide';
+```
+
+3. use the variables in your code, i.e.:
+```scss
+{
+	h1: {
+		color: $colour-primary;
+	}
+}
+```

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

2117

increased by23.01%

Number of package files

6

increased by50%

Number of lines in readme file

30

increased by275%

No dependency changes