Skip to content

Commit

Permalink
chore: updates docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Pixelik committed Oct 12, 2023
1 parent 59024cd commit 33e99af
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@

An EmberJS validation framework that is completely and utterly computed property based.

## Features
## Compatibility

* Ember.js v4.8 or above
* Ember CLI v4.8 or above
* Node.js v16 or above

## Features

- Lazily computed validations
- Ruby on rails inspired validators
- Support for Ember Data Models, Objects, Components, Services, etc.
Expand All @@ -37,17 +39,17 @@ You can also learn more by watching this Global Ember Meetup talk:
ember install ember-cp-validations
```

## Upgrading to 4.x
## Upgrading from 3.x

If you are upgrading from 3.x to 4.x, please checkout the [upgrading documentation](UPGRADING.md).
If you are upgrading from 3.x, please checkout the [upgrading documentation](UPGRADING.md).

## Helpful Links

- ### [Live Demo](http://adopted-ember-addons.github.io/ember-cp-validations)

- ### Documentation

- [4.x](http://adopted-ember-addons.github.io/ember-cp-validations/docs)
- [6.x](http://adopted-ember-addons.github.io/ember-cp-validations/docs)
- [3.x](https://rawgit.com/adopted-ember-addons/ember-cp-validations/c4123c983e54f24dd790ffa1bad66cfdf2f47ec6/docs/index.html)

- ### [Changelog](CHANGELOG.md)
Expand Down
8 changes: 4 additions & 4 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Upgrading v3.x to 4.x
# Upgrading from v3.x

This document is here to show breaking changes when upgrading from v3.x to v4.x.
This document is here to show breaking changes when upgrading from v3.x.

## Support Latest 2 LTS Releases

Expand All @@ -16,7 +16,7 @@ to the `validator` but it didn't feel consistent with the rest of the API. To no
this, we created a new `inline` validator that you can pass a function to via
the `validate` option.

**Before (3.x)**
**Version <= 3.x**

```javascript
validator(function(value, options, model, attribute) {
Expand All @@ -28,7 +28,7 @@ validator(function(value, options, model, attribute) {
});
```

**After (4.x)**
**Version >= 4.x**

```javascript
validator('inline', {
Expand Down

0 comments on commit 33e99af

Please sign in to comment.