@avalanche/object-media - npm Package Compare versions

Comparing version 4.0.0-alpha.2 to 4.0.0-alpha.3

package.json

@@ -9,3 +9,3 @@ {
   ],
-  "version": "4.0.0-alpha.2",
+  "version": "4.0.0-alpha.3",
   "author": "Markus Oberlehner",
@@ -22,5 +22,5 @@ "homepage": "https://avalanche.oberlehner.net/",
   "dependencies": {
-    "@avalanche/setting-spacings": "^4.0.0-alpha.3"
+    "@avalanche/setting-spacings": "^4.0.0-alpha.4"
   },
   "main": "scss/index.scss"
 }

README.md

@@ -12,4 +12,10 @@ # @avalanche/object-media
 ## Basic usage
-This package requires that [node-sass](https://github.com/sass/node-sass) (or one of the grunt, gulp, etc. equivalents) in combination with the [node-sass-magic-importer](https://github.com/maoberlehner/node-sass-magic-importer) custom importer is used.
+```scss
+// Import the main file.
+@import 'node_modules/@avalanche/object-media/scss/index.scss';
+```
 
+## Usage with [node-sass-magic-importer](https://github.com/maoberlehner/node-sass-magic-importer)
+Using [node-sass](https://github.com/sass/node-sass) (or a plugin for Grunt, gulp or webpack which is using node-sass) in combination with the [node-sass-magic-importer](https://github.com/maoberlehner/node-sass-magic-importer) custom importer, can make importing CSS dependencies from `node_modules` a much nicer experience.
+
 ```scss
@@ -19,5 +25,2 @@ // Import the main file.
 
-// Import just the mixin file.
-@import '~@avalanche/object-media/scss/mixins';
-
 // Import just the classes you need.
@@ -57,3 +60,3 @@ @import '{ .o-media, .o-media__body } from ~@avalanche/object-media';
 ```scss
-@import '~@avalanche/object-media/scss/mixins';
+@import 'node_modules/@avalanche/object-media/scss/mixins';
 
@@ -74,5 +77,13 @@ // Usage.
 
+## Settings
+```scss
+/// Default spacing.
+/// @type String
+$o-media-spacing-default: m !default;
+```
+
 ## About
 ### Author
 Markus Oberlehner  
+Website: https://markus.oberlehner.net  
 Twitter: https://twitter.com/MaOberlehner  
@@ -79,0 +90,0 @@ PayPal.me: https://paypal.me/maoberlehner

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

4774

increased by2.1%

Number of lines in readme file

91

increased by13.75%

Dependency changes

• Updated@avalanche/setting-spacings@^4.0.0-alpha.4