Skip to content

Commit

Permalink
update README and CHANGELOG
Browse files Browse the repository at this point in the history
- add shield images with build status and npm version to readme
- add "Features Overview" section, small syntax updates
- update changelog
  • Loading branch information
akuzko committed Feb 26, 2017
1 parent 56ef1c2 commit db8cf1b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
8 changes: 5 additions & 3 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
=== master

Add Form#reset method and other improvements

=== 1.1.0

Reduce complexity of code organization, fixes (akuzko)
Reduce complexity of code organization, fixes

Add bindState helper method, improve Form props (akuzko)
Add bindState helper method, improve Form props

Fix rendering flaws in Demo forms, add CHANGELOG (akuzko)
Fix rendering flaws in Demo forms, add CHANGELOG

=== 1.0.0
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ React Form Base

Base Form component for building convenient forms for [React](https://facebook.github.io/react/).

[![build status](https://img.shields.io/travis/akuzko/react-form-base/master.svg?style=flat-square)](https://travis-ci.org/akuzko/react-form-base)
[![npm version](https://img.shields.io/npm/v/react-form-base.svg?style=flat-square)](https://www.npmjs.com/package/react-form-base)

## Features Overview

- Controlled Form, i.e. it works with input values passed in props as JS object.
- Simple API that handles deeply nested values and collections.
- Flexible and conventient validation that allows to validate inputs as user types.
- Allows to easily turn any existing component into a Form Input component.

## Installation

```
Expand Down Expand Up @@ -271,9 +281,9 @@ class Page extends Component {
}
```

#### `bindState` helper method
#### `bindState` helper function

`react-form-base` also ships `bindState(component, key = 'form')` helper method
`react-form-base` also ships `bindState(component, key = 'form')` helper function
that will generate `{ attrs, onChange }` props object for a given component.
For instance, form from example above using this helper will look like so:

Expand Down

0 comments on commit db8cf1b

Please sign in to comment.