react-habitat-redux - npm Package Compare versions

Comparing version 1.0.0-beta2 to 1.0.0

package.json

 {
   "name": "react-habitat-redux",
-  "version": "1.0.0-beta2",
+  "version": "1.0.0",
   "description": "Brings Redux connect capabilities with React Habitat",
@@ -58,3 +58,4 @@ "main": "./lib/index.js",
     "karma-webpack": "^1.8.0",
-    "webpack": "^1.13.0"
+    "webpack": "^1.13.0",
+		"redux": "^3.0.0"
   },
@@ -65,4 +66,3 @@ "dependencies": {
     "react-habitat": "^0.2.0-beta3",
-    "react-redux": "^4.0.0",
-    "redux": "^3.0.0"
+    "react-redux": "^4.0.0"
   },
@@ -69,0 +69,0 @@ "scripts": {

readme.md

@@ -1,5 +0,3 @@
-![Deloitte Digital](https://raw.githubusercontent.com/DeloitteDigital/DDBreakpoints/master/docs/deloittedigital-logo-white.png)
+# React Habitat Redux ![Build Status](https://travis-ci.org/DeloitteDigitalAPAC/react-habitat-redux.svg?branch=master)
 
-# React Habitat Redux ![Build Status](https://travis-ci.org/DeloitteDigitalAPAC/react-habitat-redux.svg?branch=develop)
-
 This library brings [Redux](http://redux.js.org/) capabilities to [React-Habitat](https://github.com/DeloitteDigitalAPAC/react-habitat)
@@ -9,23 +7,32 @@
 
+**This library requires [react-habitat](https://github.com/DeloitteDigitalAPAC/react-habitat) and [react-redux](https://github.com/reactjs/react-redux/).**
+
 Install with Node Package Manager (NPM)
 
-`npm install react-habitat react-habitat-redux --save-dev`
+`npm install react-habitat-redux --save-dev`
 
-*Note* npm deprecated auto installing of peer dependencies since npm@3, so you will additionally need to install these dependencies if you haven't already.
+This assumes that you’re using [npm](http://npmjs.com/) package manager with a module bundler like [Webpack](http://webpack.github.io) or [Browserify](http://browserify.org/).
 
-- Redux `npm install redux --save-dev`
-- React-Redux `npm install react-redux --save-dev`
-- React `npm install react --save-dev`
-- React-Dom `npm install react-dom --save-dev`
+If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactHabitatRedux` available as a global object, you can grab a pre-built version from the dist folder.
 
 ## Usage
 
-[React Habitat Documentation](https://github.com/DeloitteDigitalAPAC/react-habitat)
+You should first familirise yourself with React Habitat and [its docs](https://github.com/DeloitteDigitalAPAC/react-habitat#getting-started)
 
-When configuring the React Habitat Bootstrapper, you'll want to use the Redux Container instead of the default one like so:
+When configuring the React Habitat Bootstrapper, you'll want to use the Redux `Container` instead of the default one and pass in your *store* like so:
 
+```javascript
+// Create a store
+const store = configureStore();
 
+// Create a new 'Redux' container builder for the store
+var container = new ReactHabitatRedux.Container(store);
+```
+It's important that you pass in the store object if you want redux 'connect' to work automatically.
+
+Here is a full class example:
+
 ```javascript
 import ReactHabitat                 from 'react-habitat';
-import ReduxHabitat                 from 'react-habitat-redux';
+import ReactHabitatRedux            from 'react-habitat-redux';
 import { createStore }              from 'redux';
@@ -40,3 +47,3 @@
         super();
-        
+
         // Create a store
@@ -46,3 +53,3 @@ const store = configureStore();
         // Create a new 'Redux' container builder for the store
-        var container = new ReduxHabitat.Container(store);
+        var container = new ReactHabitatRedux.Container(store);
 
@@ -62,16 +69,2 @@ // Register your top level component(s)
 
-It's important that you pass in the store object if you want redux 'connect' to work automatically.
-
-## Want to contribute?
-
-* Got an amazing idea to make this better?
-* Found an annoying bug?
-
-Please don't hesitate to raise an issue through GitHub or open a pull request to show off your fancy pants coding skills - we'll really appreciate it!
-
-## Key Contributors
-
-### Deloitte Digital Australia
-* @jennasalau
-
 ## Who is Deloitte Digital?
@@ -78,0 +71,0 @@

webpack.config.js

@@ -17,5 +17,12 @@ var webpack = require('webpack');
 	output: {
-		library: 'ReactHabitat',
+		library: 'ReactHabitatRedux',
 		libraryTarget: 'umd'
 	},
+	externals: {
+		'react': 'React',
+		'react-dom': 'ReactDOM',
+		'redux': 'Redux',
+		'react-redux': 'ReactRedux',
+		'react-habitat': 'ReactHabitat'
+	},
 	plugins: [
@@ -22,0 +29,0 @@ {

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

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

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

Dependency count

4

decreased by-20%

Worsened metrics

Total package byte prevSize

50033

decreased by-97.32%

Dev dependency count

22

increased by4.76%

Lines of code

581

decreased by-98.57%

Number of lines in readme file

103

decreased by-6.36%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removedredux@^3.0.0