Skip to content

Commit 41d5eee

Browse files
committed
fixed markdown
1 parent 6386dac commit 41d5eee

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

readme.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,31 @@
22

33
WELCOME TO THE COLDBOX VALIDATION MODULE
44
========================================
5-
ColdBox sports its own server side validation engine so it can provide you with a unified approach to object and form validation.
5+
This module is a server side rules validation engine that can provide you with a unified approach to object, struct and form validation. You can construct validation constraint rules and then tell the engine to validate them accordingly.
66

7-
##LICENSE
7+
## LICENSE
88
Apache License, Version 2.0.
99

10-
##IMPORTANT LINKS
10+
## IMPORTANT LINKS
1111
- https://github.com/coldbox-modules/cbox-validation
12-
- https://forgebox.io/view/validation
1312
- https://github.com/coldbox-modules/cbox-validation/wiki
13+
- https://forgebox.io/view/validation
1414

15-
##SYSTEM REQUIREMENTS
15+
## SYSTEM REQUIREMENTS
1616
- Lucee 4.5+
17-
- ColdFusion 10+
17+
- Adobe ColdFusion 11+
1818

1919
INSTRUCTIONS
2020
============
2121

22-
Just drop into your **modules** folder or use the box-cli to install
22+
Just drop into your **modules** folder or use CommandBox to install:
2323

2424
`box install cbvalidation`
2525

26-
The module will register several objects into WireBox using the `@cbvalidation` namespace. The validation manager is registered as `ValidationManager@cbvalidation`
26+
The module will register several objects into WireBox using the `@cbvalidation` namespace. The validation manager is registered as `ValidationManager@cbvalidation`. It will also register several helper methods that can be used throughout the ColdBox application.
2727

2828
## Mixins
29+
2930
The module will also register two methods in your handlers/interceptors/layouts/views
3031

3132
```js
@@ -36,6 +37,7 @@ The module will also register two methods in your handlers/interceptors/layouts/
3637
* @constraints A structure of constraint rules or the name of the shared constraint rules to use for validation
3738
* @locale The i18n locale to use for validation messages
3839
* @excludeFields The fields to exclude in the validation
40+
* @includeFields The fields to include ONLY in the validation
3941
*
4042
* @return cbvalidation.model.result.IValidationResult
4143
*/
@@ -48,12 +50,14 @@ function getValidationManager()
4850
```
4951

5052
## Settings
53+
5154
Here are the module settings you can place in your `ColdBox.cfc` by using the `validation` settings structure:
5255

5356
```js
5457
validation = {
5558
// The third-party validation manager to use, by default it uses CBValidation.
5659
manager = "class path",
60+
5761
// You can store global constraint rules here with unique names
5862
sharedConstraints = {
5963
name = {
@@ -66,11 +70,16 @@ validation = {
6670

6771
You can read more about ColdBox Validation here: - https://github.com/coldbox-modules/cbox-validation/wiki
6872

73+
---
74+
75+
```
6976
********************************************************************************
7077
Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
7178
www.coldbox.org | www.luismajano.com | www.ortussolutions.com
7279
********************************************************************************
73-
####HONOR GOES TO GOD ABOVE ALL
80+
```
81+
82+
#### HONOR GOES TO GOD ABOVE ALL
7483
Because of His grace, this project exists. If you don't like this, then don't read it, its not for you.
7584

7685
>"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ:
@@ -80,5 +89,5 @@ And patience, experience; and experience, hope:
8089
And hope maketh not ashamed; because the love of God is shed abroad in our hearts by the
8190
Holy Ghost which is given unto us. ." Romans 5:5
8291

83-
###THE DAILY BREAD
92+
### THE DAILY BREAD
8493
> "I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12

0 commit comments

Comments
 (0)