@mintlab/ui - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

package.json

 {
   "name": "@mintlab/ui",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "EUPL-1.1",
@@ -14,2 +14,3 @@ "description": "Mintlab Preact UI components used in Zaaksysteem.",
     "esdoc": "esdoc",
+    "icons": "node ./material-icons/build.js",
     "lint": "eslint ./App ./storybook",
@@ -22,5 +23,4 @@ "plop": "plop",
     "storybook": "NODE_ENV=production build-storybook -c ./storybook -o ./public",
-    "prepublish": "npm run build",
-    "prepipeline": "npm install",
-    "pipeline": "npm run storybook"
+    "prepipeline": "yarn",
+    "pipeline": "yarn storybook"
   },
@@ -34,3 +34,3 @@ "jest": {
     "testMatch": [
-      "<rootDir>/App/**/*.test.js"
+      "<rootDir>/**/*.test.js"
     ]
@@ -66,3 +66,2 @@ },
     "node-sass": "^4.6.1",
-    "open-browser-webpack-plugin": "^0.0.5",
     "optimize-css-assets-webpack-plugin": "^3.2.0",
@@ -86,4 +85,5 @@ "parent-module": "^0.1.0",
     "url-loader": "^0.6.2",
-    "webpack": "^3.8.1"
+    "webpack": "^3.8.1",
+    "xmldom": "^0.1.27"
   }
 }

README.md

@@ -12,17 +12,26 @@ # @mintlab/ui  [![npm version][npm-image]][npm-url]
 
-## Requirements
+## Starting the application
 
-- **Node.js** version 8.9.1 
-  [LTS](https://github.com/nodejs/Release#release-schedule)
-    - Install with
-        - **GNU/Linux** & **macOS**: [nvm](https://github.com/creationix/nvm)
-        - **Windows**: [nvm-windows](https://github.com/coreybutler/nvm-windows).
-- **Yarn**
-    - **Important**: If you install yarn with 
-      [Homebrew](https://brew.sh/)
-      on macOS, be sure to exclude Node.js.
-      
-          $ brew install yarn --without-node
-    - [Installation](https://yarnpkg.com/lang/en/docs/install/).
+Run
 
+    $ docker-compose up ui
+
+and in another tab
+
+    $ docker-compose exec ui sh
+
+or in a single step (`bash`):
+  
+    $ ./dev.sh
+
+The first time in the guest you'll want to run
+
+    $ yarn
+
+to install dependenecies and then
+
+    $ yarn start
+
+to run storybook.
+
 ## Configuration and infrastructure documentation
@@ -77,6 +86,14 @@
 - Only publish with the `npm` CLI.
-- The build is a `prepublish task` so just run `npm publish --access public`.
+- The build is a `prepublish` task so just run `npm publish --access public`.
 
+##
+
+- [Official Node.js Docker repository](https://hub.docker.com/_/node/)
+
 ## FAQ
 
+**Q: Why do I see so many peer dependency warnings about React when I install modules?**
+
+A: `preact-compat` is aliased as `react` in the Storybook webpack configuration.
+
 **Q: Why do I see "Warning: Failed prop type: The prop `className` is marked as required in `Resizer`, 
@@ -83,0 +100,0 @@ but its value is `undefined`." in the console?**

No alert changes

Improved metrics

Total package byte prevSize

241084

increased by82.07%

Number of lines in readme file

122

increased by16.19%

No dependency changes