From 5d57af4b346367f97ca2f290d5c9aa2eb35f27fe Mon Sep 17 00:00:00 2001 From: Scott Kobewka Date: Wed, 17 Feb 2016 16:27:57 -0500 Subject: [PATCH] Update README.md Making it a little easier to read the descriptions of the three validate methods. --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f14fe25a..64319d91 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,11 @@ $ gem install json-schema-2.5.2.gem Usage ----- -Three base validation methods exist: `validate`, `validate!`, and -`fully_validate`. The first returns a boolean on whether a validation attempt -passes and the second will throw a `JSON::Schema::ValidationError` with an -appropriate message/trace on where the validation failed. The third validation -method does not immediately fail upon a validation error and instead builds an -array of validation errors return when validation is complete. +Three base validation methods exist: + +1. `validate`: returns a boolean on whether a validation attempt passes +2. `validate!`: throws a `JSON::Schema::ValidationError` with an appropriate message/trace on where the validation failed +3. `fully_validate`: builds an array of validation errors return when validation is complete All methods take two arguments, which can be either a JSON string, a file containing JSON, or a Ruby object representing JSON data. The first argument to