@texastribune/queso-ui - npm Package Compare versions

Comparing version 2.0.0-2 to 2.0.0

package.json

 {
   "name": "@texastribune/queso-ui",
-  "version": "2.0.0-2",
+  "version": "2.0.0",
   "description": "Asset library of SCSS and SVG files",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -12,5 +12,22 @@ # @texastribune/queso-ui
 
-## Install
+## Getting started
+To preview these assets and accompanying docs locally, run the following commands:
+```sh
+yarn
+```
 
 ```sh
+yarn dev
+```
+Visit http://localhost:3000
+
+This spins up a browsersync server and watch task for all SCSS and HTML files.
+
+**Requirements**
+- node >=8.11.3 (to be replaced with a docker container)
+
+
+## Installing as a dependency
+
+```sh
 yarn add @texastribune/queso-ui --dev
@@ -17,0 +34,0 @@ ```

Fixed alerts

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

Improved metrics

Total package byte prevSize

233377

increased by0.16%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

177

increased by10.63%

No dependency changes