loomcss - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "loomcss",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Weave your own pattern libraries.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -42,10 +42,20 @@ # Loom
 
-For now, you're going to have to compile by hand: `sass assets/main.scss > main.css`. Hey, this is still massively alpha!
+```bash
+$ npm install loomcss --save-dev
+```
 
 # Usage
 
-Once installed, copy the `main.scss` file to your project. Make sure that the paths are pointing to the correct locations.
+Once installed, you will need to add the installation path to your own build system. This will probably be something like `node_modules/loomcss/assets`.
 
-This library is a basis for your own design system.
+Once you have made that folder available to your build you can access the Loom layers using:
 
+```scss
+@import 'loom/10-global-settings/misc';
+// etc
+```
+DON'T just link to `main.scss`! This will prevent you getting access to the interweaved layers of the ITCSS stack. Instead, copy [the list of imports](https://github.com/sonniesedge/loom/blob/master/assets/main.scss) from `main.scss` into your main project file. Yes, it feels unusual, but you'll gain a lot of power by doing so.
+
+This library is a basis for your own design system and won't give you much visually out of the box!
+
 # Organisation layers
@@ -52,0 +62,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

55939

increased by0.46%

Number of lines in readme file

111

increased by9.9%

No dependency changes