Update changelog/readme/comments

Author: tswaters

CHANGELOG.MD

@@ -1,3 +1,8 @@
+# 1.0.3
+
+- why are badges so difficult to get right? fixing it for real this time
+- stop checking after first error encountered, return that
+
 # 1.0.2
 
 - Another hack at badges, more tooling

readme.md

@@ -4,13 +4,13 @@
   <img src="https://img.shields.io/npm/v/@tswaters/react-form-validation" alt="npm version">
 </a>
 <a href="https://travis-ci.org/tswaters/react-form-validation/">
-  <img src="https://img.shields.io/travis/tswaters/react-form-validation" alt="npm version">
+  <img src="https://img.shields.io/travis/tswaters/react-form-validation" alt="build status">
 </a>
 <a href="https://coveralls.io/github/tswaters/react-form-validation">
-  <img src="https://img.shields.io/coveralls/github/tswaters/react-form-validation" alt="npm version">
+  <img src="https://img.shields.io/coveralls/github/tswaters/react-form-validation" alt="coverage">
 </a>
 <a href="https://github.com/tswaters/react-form-validation/blob/master/LICENSE">
-  <img src="https://img.shields.io/npm/l/@tswaters/react-form-validation" alt="npm version">
+  <img src="https://img.shields.io/npm/l/@tswaters/react-form-validation" alt="license (MIT)">
 </a>
 
 The goal of this library is to implement the [Constraint Validation API](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#the-constraint-validation-api) in React while not getting in your way to do it.
@@ -42,7 +42,7 @@ These are wrappers around `<form/>` and `<input/select/textarea>` elements. Any
 
 `Input` elements must be children of a `Form` element. Under the covers, this library uses context to keep track of all fields on the form and will validate all of them if the form is submitted.
 
-A `Validator` component is also provided which attempts to make using the api a bit easier. This is a container element that uses a render prop which is called with `({ error, valid, invalid, validated })`. This routine recursively traverses any provided props to replace `input/select/textarea` elements with the exports from this library, so it will duplicate any work on the tree that react may have done on that JSX tree up to that point.
+A `Validator` component is also provided which attempts to make using the api a bit easier. This is a container element that uses a render prop which is called with `({ error, valid, invalid, validated })`. This routine recursively traverses any provided props to replace `input/select/textarea` elements with the exports from this library, so it will duplicate any work already done up to that point.
 
 ## api
 
@@ -274,6 +274,12 @@ const ErrorDisplay = error => {
 
 For custom error messages, `error.message` will be whatever you returned or threw back and the code will be `customError`
 
+## Thoughts on Performance
+
+- make sure the tree passed via `<Validator />` is pretty simple. Validator recursively traverses the tree and replaces html inputs with exports from this library.
+
+- validation functions should be memoized lest any change invoke a re-render (wrap functions with `useCallback`, or an array of functions with `memo`)
+
 ## limitations / bugs
 
 - only the first error for a given input element will be returned

src/form.js

@@ -15,7 +15,7 @@ const Form = forwardRef(({ onSubmit, ...rest }, ref) => {
   const fields = useRef([])
 
   /**
-   * This is invoked from `useFormContext`
+   * This is invoked from `useValidation`
    * Each element, as it's mounted, must register with us so we can do things with them
    * This happens in a `useEffect` - the disposable will call the unregister function.
    */