Skip to content

Commit 2ffd0a4

Browse files
authored
docs: Add guide for upgrading from 1.x to 2.x to README (#142)
* Add guide for upgrading from 1.x to 2.x to README * More info on 2.x branch, remove examples link * Update README.md
1 parent d0a1fcb commit 2ffd0a4

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
A form input builder and validator for React.
1010

11-
| [Quick Start](#quick-start) | [API](/API.md) | [Examples](/examples) |
12-
| --------------------------- | -------------- | --------------------- |
11+
| [Quick Start](#quick-start) | [API](/API.md) |
12+
| --------------------------- | -------------- |
1313

1414
## Background
1515

@@ -31,6 +31,29 @@ This project was originally located at https://github.com/christianalfoni/formsy
3131

3232
`yarn add formsy-react react react-dom` and use with webpack, browserify, etc.
3333

34+
## Join the 2.x beta
35+
36+
The 2.0 release is currently in active development on master, but not yet released publicly. The API docs are still
37+
written for the 1.x branch and will remain that way until release. However, the API changes are minor and listed below.
38+
If you'd like to upgrade to formsy 2.x you can run:
39+
40+
```
41+
yarn upgrade [email protected]
42+
```
43+
44+
**Element prop breaking changes:**
45+
- getErrorMessage() => errorMessage
46+
- getErrorMessages() => errorMessages
47+
- getValue() => value
48+
- hasValue() => hasValue,
49+
- isFormDisabled(): => isFormDisabled,
50+
- isValid(): => isValid,
51+
- isPristine(): => isPristine,
52+
- isFormSubmitted(): => isFormSubmitted,
53+
- isRequired(): => isRequired,
54+
- showRequired(): => showRequired,
55+
- showError(): => showError,
56+
3457
## Quick Start
3558

3659
### 1. Build a Formsy element

0 commit comments

Comments
 (0)