Fixed docs

Author: erikras

README.md

@@ -63,8 +63,23 @@ const undecorate = decorator(form)
 
 ## API
 
-### `createDecorator
+### `createDecorator: (...calculations: Calculation[]): Decorator`
 
-### `form.mutators.setFieldData(name: string, values: Object) => void`
+A function that takes a set of calculations and returns a 🏁 Final Form
+[`Decorator`](https://github.com/final-form/final-form#decorator-form-formapi--unsubscribe).
 
-Merges the values provided into the `data` value for the specified field
+## Types
+
+### `Calculation: { field: FieldPattern, updates: Updates }`
+
+A calculation to perform
+
+### `FieldName: string`
+
+### `FieldPattern: FieldName | RegExp`
+
+A pattern to match a field with.
+
+### `Updates: { [FieldName]: (value: any, allValues: Object) => any }`
+
+Updates to make on other fields.

package.json

@@ -1,19 +1,19 @@
 {
   "name": "final-form-calculate",
   "version": "1.0.0",
-  "description": "Mutator for setting arbitrary metadata on fields in 🏁 Final Form",
+  "description":
+    "Decorator for calculating field values based on other field values in 🏁 Final Form",
   "main": "dist/final-form-calculate.cjs.js",
   "jsnext:main": "dist/final-form-calculate.es.js",
   "module": "dist/final-form-calculate.es.js",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "scripts": {
     "start": "nps",
     "test": "nps test",
     "precommit": "lint-staged && npm start validate"
   },
-  "author": "Erik Rasmussen <[email protected]> (http://github.com/erikras)",
+  "author":
+    "Erik Rasmussen <[email protected]> (http://github.com/erikras)",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -61,10 +61,7 @@
     "final-form": "^1.3.0"
   },
   "lint-staged": {
-    "*.{js,json,md,css}": [
-      "prettier --write",
-      "git add"
-    ]
+    "*.{js,json,md,css}": ["prettier --write", "git add"]
   },
   "bundlesize": [
     {

src/decorator.js

@@ -1,9 +1,9 @@
 // @flow
 import type { Decorator, FormApi } from 'final-form'
-import type { Calculations, Updates } from './types'
+import type { Calculation, Updates } from './types'
 import { getIn } from 'final-form'
 
-const createDecorator = (...calculations: Calculations): Decorator => (
+const createDecorator = (...calculations: Calculation[]): Decorator => (
   form: FormApi
 ) => {
   let previousValues = {}

src/types.js.flow

@@ -5,8 +5,7 @@ export type Updates = {
   [FieldName]: (value: any, allValues: Object) => any
 }
 
-type Calculation = {
+export type Calculation = {
   field: FieldPattern,
   updates: Updates
 }
-export type Calculations = Calculation[]