react-redux-subspace - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

package.json

 {
   "name": "react-redux-subspace",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "react-redux Provider extension for redux-subspace",
@@ -29,3 +29,3 @@ "author": "Michael Peyper",
     "recompose": "^0.26.0",
-    "redux-subspace": "^2.1.0"
+    "redux-subspace": "^2.1.1"
   },
@@ -32,0 +32,0 @@ "peerDependencies": {

README.md

@@ -7,3 +7,3 @@ # react-redux-subspace
 
-This is a library to create subspaces for Redux connected React components. It's designed to work with Provider from the [react-redux](https://github.com/reactjs/react-redux) bindings.
+This is an extension for [redux-subspace](/) to create subspaces for Redux connected React components. It's designed to work with the `Provider` component from the [react-redux](https://github.com/reactjs/react-redux) bindings.
 
@@ -13,8 +13,43 @@ ## Installation
 ```sh
-npm install --save react-redux-subspace
+npm install --save react redux react-redux redux-subspace react-redux-subspace
 ```
 
+## Quick Start
+
+```javascript
+import React from 'react'
+import { createStore, combineReducers } from 'redux'
+import { Provider } from 'react-redux'
+import { namespaced } from 'redux-subspace'
+import { SubspaceProvider } from 'react-redux-subspace'
+import { TodoApp, todoReducer } from './todoApp'
+import { CounterApp, counterReducer } from './counterApp'
+
+const rootReducer = combineReducers({
+  todo: todoReducer
+  counter1: namespaced('counter1')(counterReducer),
+  counter2: namespaced('counter2')(counterReducer)
+})
+
+const store = createStore(rootReducer)
+
+const App = () => (
+  <Provider store={store}>
+    <SubspaceProvider mapState={(state) => state.todo}>
+      <TodoApp />
+    </SubspaceProvider>
+    <SubspaceProvider mapState={(state) => state.counter1} namespace="counter1">
+      <CounterApp />
+    </SubspaceProvider>
+    <SubspaceProvider mapState={(state) => state.counter2} namespace="counter2">
+      <CounterApp />
+    </SubspaceProvider>
+  </Provider>
+)
+```
+
 ## Documentation
 
 * [Usage](/packages/react-redux-subspace/docs/Usage.md)
+* [Examples](/docs/Examples.md#react-redux-subspace)
 * [API Reference](/packages/react-redux-subspace/docs/api/README.md)

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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18351

increased by6.46%

Number of lines in readme file

54

increased by184.21%

Dependency changes

• Updatedredux-subspace@^2.1.1