Add basic usage info

maxdeviant · May 15, 2016 · 0758699 · 0758699
1 parent b33f6cf
commit 0758699
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
 # redux-persist-transform-encrypt
 Encrypt your Redux store.
+
+## Usage
+
+```js
+import createEncryptor from 'redux-persist-transform-encrypt';
+
+const encryptor = createEncryptor({
+  secretKey: 'my-super-secret-key'
+});
+
+persistStore(store, {
+  transforms: [
+    encryptor
+  ]
+});
+
+```
diff --git a/test/spec.js b/test/spec.js
@@ -1,9 +1,9 @@
 import { expect } from 'chai';
-const createTransform = require('../');
+const createEncryptor = require('../');
 
 describe('redux-persist-transform-encrypt', () => {
   it('can encrypt incoming state', () => {
-    const encryptTransform = createTransform({
+    const encryptTransform = createEncryptor({
       secretKey: 'redux-is-awesome'
     });
 
@@ -19,7 +19,7 @@ describe('redux-persist-transform-encrypt', () => {
   });
 
   it('can decrypt outgoing state', () => {
-    const encryptTransform = createTransform({
+    const encryptTransform = createEncryptor({
       secretKey: 'redux-is-awesome'
     });