redux-persist-webextension-storage - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "redux-persist-webextension-storage",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "WebExtension Storage engine for redux-persist",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

README.md

 # redux-persist-webextension-storage
-WebExtension Storage engine for redux-persist
+A [WebExtension Storage][0] storage engine for [redux-persist][1].
+
+## Installation
+
+Add the [redux-persist-webextension-storage][2] NPM package via NPM or Yarn:
+
+```bash
+$ yarn add redux-persist-webextension-storage
+```
+
+## Usage
+
+There are separate storage engines for [local storage][3] and [sync storage][4]. Import the one you need,
+or both, and pass them as storage engines when configuring your store.
+
+```js
+// configureStore.js
+
+import { combineReducers, createStore } from 'redux'
+import { persistStore, persistReducer } from 'redux-persist'
+import { localStorage, syncStorage } from 'redux-persist-webextension-storage'
+
+import localStorageReducer from './localStorageReducer';
+import syncStorageReducer from './syncStorageReducer';
+
+const localStorageConfig = {
+  key: 'localStorage',
+  storage: syncStorage,
+}
+
+const syncStorageConfig = {
+  key: 'syncStorage',
+  storage: syncStorage,
+}
+
+// Persist each of the storage areas under different keys and with different storage engines.
+const rootReducer = combineReducers({
+  localStorage: persistReducer(localStorageConfig, localStorageReducer),
+  syncStorage: persistReducer(syncStorageConfig, syncStorageReducer),
+})
+
+export default () => {
+  const store = createStore(rootReducer)
+  const persistor = persistStore(store)
+  return { store, persistor }
+}
+```
+
+[0]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/storage
+[1]: https://github.com/rt2zz/redux-persist
+[2]: https://www.npmjs.com/package/redux-persist-webextension-storage
+[3]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/storage/local
+[4]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/storage/sync

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

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

Improved metrics

Total package byte prevSize

60015

increased by2.78%

Number of lines in readme file

55

increased by1733.33%

No dependency changes