flexgriddle - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "flexgriddle",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A sass mixin library for creating simple grids using flexbox",
@@ -25,2 +25,2 @@ "scripts": {
   }
-}
+}

README.md

@@ -1,1 +0,32 @@
-# flexgrid
+# Flexgrid
+A sass mixin library for creating simple grids using flexbox
+
+## Install
+```cli
+npm install --save flexgriddle
+```
+
+## Usage
+This library consists of two mixins which enable you to make a simple grid using `flexbox`.
+
+### Specify the grid container
+```scss
+.gallery {
+  @include flexgrid-container();
+}
+```
+Argument:
+- __$gutter__ _Optional_. Size of the gutter.
+
+### Specify the grid items
+```scss
+.gallery__item {
+  @include flexgrid-item(5);
+}
+```
+Arguments:
+- __$number-of-items__. The number of items that one row will contain.
+- __$gutter__ _Optional_. Size of the gutter. Should be the same as its container gutter size.
+
+## License
+MIT

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

190822

increased by0.34%

Number of lines in readme file

32

increased by3100%

No dependency changes