Merge pull request #18 from rpearce/maintenance

maintenance, bumps, license, builds

Author: rpearce

.browserslistrc

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - "12"
+  - "13"
 cache: yarn
 after_success:
   - npm run coverage

.travis.yml

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [4.1.0] - 2019-12-29
+
+### Added
+* added `browser` field for umd build
+
+### Changed
+* bumped all deps
+* updated `main` and `module` fields
+* license from ISC to BSD-3
+* moved API docs back to README
+
+### Removed
+* `.browserslistrc` file (just use babel preset-env default)
+
 ## [4.0.0] - 2019-09-12
 
 ### Changed

API.md

@@ -1,7 +1,30 @@
-ISC License (ISC)
+Copyright (c) 2019, Robert Pearce
 
-Copyright 2018 Robert Pearce
+All rights reserved.
 
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Robert Pearce nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

CHANGELOG.md

@@ -11,11 +11,64 @@ following to an element that wants to be a "button":
   * enforced labelling via either `aria-label` or `children`
 
 ## Links
-* [`API Documentation`](./API.md)
-* [`Authors`](./AUTHORS)
-* [`Changelog`](./CHANGELOG.md)
-* [`Contributing`](./CONTRIBUTING.md)
-* [`Code of Conduct`](./CODE_OF_CONDUCT.md)
+* [Installation](#installation)
+* [Usage](#usage)
+* [API](#api)
+* [All Contributors](#contributors)
+* [Authors](./AUTHORS)
+* [Changelog](./CHANGELOG.md)
+* [Contributing](./CONTRIBUTING.md)
+* [Code of Conduct](./CODE_OF_CONDUCT.md)
+
+# Installation
+```
+npm i react-button-a11y
+```
+or
+```
+yarn add react-button-a11y
+```
+
+## Usage
+
+### With `aria-label`
+```js
+import ButtonA11y from 'react-button-a11y'
+
+// ...
+
+<ButtonA11y
+  aria-label="Click this to do X"
+  className="some-className"
+  onClick={evt => { console.log('press happened: ', evt) }}
+/>
+```
+
+### Without `aria-label`
+If you don't provide an `aria-label`, you need to provide `children` so that
+there is something to describe what clicking / tapping this button does.
+```js
+import ButtonA11y from 'react-button-a11y'
+
+// ...
+
+<ButtonA11y
+  className="some-className"
+  onClick={evt => { console.log('press happened: ', evt) }}
+>
+  Click this to do X
+</ButtonA11y>
+```
+
+# API
+
+| Prop | Type | Required | Default  | Details |
+| ---  | --- | ---  | --- | --- |
+| `aria-label` | String | yes if `children` absent | none | Pass an `aria-label` if you don't pass children with descriptive text |
+| `children` | Node | yes if `aria-label` absent | none | Pass `children` with descriptive text if you don't pass an `aria-label` |
+| `element` | String | no | `'span'` | The default element is a `div`, but you can pass a `span`, e.g., if you like |
+| `onClick` | Function | yes | `Function.prototype` | When the button is "pressed" (via Enter or Spacebar or click), this callback will be triggered with the event |
+| `strictMode` | Bool | no | `true` | An error will be thrown if enabled and you fail to pass both an `aria-label` and `children` |
 
 ## Contributors