boostrap-queries - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "boostrap-queries",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Sass media query library based on Bootrap v5 breakpoints",
@@ -5,0 +5,0 @@ "main": "bootstrap-queries.scss",

README.md

 # Bootstrap Queries
 Sass mixins based on bootstraps V5 media query breakpoints
 
-### Example
+### Install
+```
+npm i boostrap-queries
+```
+
+### Mixins
+
+Create a media query finishing at <576px
+```scss
+@include screen-x-small() {
+  ...
+}
+```
+
+Create a media query finishing at ≥576px
+```scss
+@include screen-x-small() {
+  ...
+}
+```
+
+Create a media query starting at ≥768px
+
+```scss
+@include screen-medium() {
+  ...
+}
+
+```
+
+Create a media query starting at ≥992px
+
+```scss
+@include screen-large() {
+  ...
+}
+```
+
+Create a media query starting at ≥1200px
+
+```scss
+@include screen-extra-large() {
+  ...
+}
+```
+
+Create a media query starting at ≥1400px
+
+```scss
+@include screen-extra-extra-large() {
+  ...
+}
+```
+
+### Functions
+
+Get x-small dimension
+```scss
+$bootstrap-x-small: get-x-small();
+```
+
+Get small dimension
+```scss
+$bootstrap-small: get-small();
+```
+
+Get medium dimension
+```scss
+$bootstrap-medium: get-medium();
+```
+
+Get large dimension
+```scss
+$bootstrap-large: get-large();
+```
+
+Get extra-large dimension
+```scss
+$bootstrap-extra-large: get-extra-large();
+```
+
+Get extra-extra-large dimension
+```scss
+$bootstrap-extra-extra-large: get-extra-extra-large()
+```

No alert changes

Improved metrics

Total package byte prevSize

8089

increased by78.68%

Number of lines in readme file

88

increased by1660%

No dependency changes