supercell - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

package.json

 {
   "name": "supercell",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Grid-like layout system.",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -1,6 +0,12 @@
-# Supercell
+[![npm version](https://badge.fury.io/js/supercell.svg)](https://badge.fury.io/js/supercell)
 
-_Supercell is an ITCSS-compatible library for building grid-like structures in our
-UIs. It can be consumed on its own, or as part of Toolkit._
+# Supercell 
 
+> **Fluid, responsive, nestable, reorderable, mobile-first layouts.**
+
+Supercell is an [ITCSS-compatible](https://twitter.com/itcss_io) library for building grid-like structures in our
+UIs. 
+
+It can be consumed on its own, or as part of [Toolkit](https://github.com/sky-uk/toolkit).
+
 ## Contents
@@ -11,6 +17,10 @@
 3. [Usage](#usage)
-  1. [Responsive](#responsive)
-4. [Options](#options)
-5. [Example](#example)
+4. [Responsive](#responsive)
+5. [Options](#options)
+6. [Example](#example)
+7. [Versioning](#versioning)
+8. [Contributing](#contributing)
 
+**N.B.** If you are using Supercell as part of [Toolkit](https://github.com/sky-uk/toolkit), you will not need to install or configure anything. Please ignore the first two sections.
+
 ## Installation
@@ -28,3 +38,3 @@
 by `_tools.widths.scss`’ mixin in order to create layout structures that are
-sized accordingly, e.g.:
+sized accordingly, for example:
 
@@ -46,5 +56,2 @@ ```HTML
 
-**N.B. If you are using Supercell as part of Toolkit, you will not need to
-configure anything. Please ignore this section.**
-
 There are only two parts of Supercell that might need configuring:
@@ -86,4 +93,6 @@
 To generate your width classes (e.g. `.u-width-1/2`) you need to call the
-`widths()` mixin in your project, passing in the number of columns you would
-like to create. To create a 12 column layout system, simply call the mixin like
+`supercell()` mixin in your project, passing in the number of columns you would
+like to create. 
+
+To create a 12 column layout system, simply call the mixin like
 so:
@@ -216,1 +225,16 @@
 ```
+
+## Versioning
+
+Supercell follows Semantic Versioning to help manage the impact of releasing new library versions.
+
+
+## Contributing
+
+We appreciate **any** contribution to Supercell.
+
+We keep a list of features and bugs in the [issue tracker](https://github.com/sky-uk/supercell/issues).
+
+### Maintainers
+
+Supercell is maintained by the [Toolkit Maintainers](https://github.com/sky-uk/toolkit#maintainers) and [Harry Roberts](https://github.com/csswizardry).

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

235

10.85%

Worsened metrics

Total package byte prevSize

18727

-74.67%

Number of package files

7

-41.67%

Number of medium supply chain risk alerts

2

100%

No dependency changes