sass-mq - npm Package Compare versions

Comparing version 3.3.2 to 4.0.0-beta.1

package.json

 {
   "name": "sass-mq",
   "description": "mq() is a Sass mixin that helps manipulating media queries in an elegant way.",
-  "version": "3.3.2",
+  "version": "4.0.0-beta.1",
   "keywords": [
@@ -6,0 +6,0 @@ "responsive",

README.md

@@ -186,2 +186,45 @@ # Media Queries with superpowers [![Build Status](https://api.travis-ci.org/sass-mq/sass-mq.svg?branch=master)](https://travis-ci.org/sass-mq/sass-mq)
 
+### Verbose and shortand notations
+
+Sometimes you’ll want to be extra verbose (e.g. if you’re developing a
+library based on top of sass-mq), however for readability in a codebase,
+the shorthand notation is recommended.
+
+All of these examples output the exact same thing, and are here for
+reference so you can use the notation that best matches your needs:
+
+```scss
+// Verbose
+@include mq(
+    $from: false,
+    $until: desktop,
+    $and: false,
+    $media-type: $mq-media-type // defaults to 'all'
+) {
+    .foo {}
+}
+
+// Omitting argument names
+@include mq(
+    false,
+    desktop,
+    false,
+    $mq-media-type
+) {
+    .foo {}
+}
+
+// Omitting tailing arguments
+@include mq(false, desktop) {
+    .foo {}
+}
+
+// Recommended
+@include mq($until: desktop) {
+    .foo {}
+}
+```
+
+[See the detailed API documentation](http://sass-mq.github.io/sass-mq/#undefined-mixin-mq)
+
 ### Adding custom breakpoints
@@ -188,0 +231,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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

22989

increased by11.11%

Number of lines in readme file

340

increased by14.48%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes