From 68a2e7f2630d444f5094b9f11abf4253c27cd81e Mon Sep 17 00:00:00 2001 From: Nicolas Martinos Date: Thu, 12 Oct 2023 02:12:30 +0300 Subject: [PATCH] chore: updates docs --- README.md | 10 ++++++---- UPGRADING.md | 8 ++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index da64504f..d7578cf1 100644 --- a/README.md +++ b/README.md @@ -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. @@ -37,9 +39,9 @@ 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 @@ -47,7 +49,7 @@ If you are upgrading from 3.x to 4.x, please checkout the [upgrading documentati - ### 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) diff --git a/UPGRADING.md b/UPGRADING.md index 96730cdd..54e0cea5 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -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 @@ -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) { @@ -28,7 +28,7 @@ validator(function(value, options, model, attribute) { }); ``` -**After (4.x)** +**Version >= 4.x** ```javascript validator('inline', {