From 4ca4bd77d3c384194340e5d11d9e4637ead47483 Mon Sep 17 00:00:00 2001 From: Alvaro Cabrera <pateketrueke@gmail.com> Date: Thu, 4 Jan 2018 14:20:48 -0600 Subject: [PATCH] Fix links; add join us! --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ff08f282..2fff0ba2 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,14 @@ [](http://inch-ci.org/github/json-schema-faker/json-schema-faker) [](http://json-schema-faker.github.io/json-schema-faker/) -Use [JSON Schema](http://json-schema.org/) along with fake generators to provide consistent and meaningful fake data for your system. +Use [JSON Schema](http://json-schema.org/draft-04/) along with fake generators to provide consistent and meaningful fake data for your system. We are looking for **contributors**! If you wanna help us make `jsf` more awesome, simply write us so! +## Join us! + +We've recently setup a [gitter room](https://gitter.im/json-schema-faker) for this project, if you want contribute, talk about specific issues from the library, or you need help on json-schema topics just reach us! + ## What's new? A release candidate for `v0.5.x` series was released in order to support local/remote reference downloading thanks to `json-schema-ref-parser`, this change forced `jsf` to be completely async. @@ -120,7 +124,7 @@ You can see [an example JS fiddle based on `jsf` loaded from cdnjs](https://jsfi JSON-Schema-faker (or `jsf` for short) combines two things: - * The [JSON-schema specification](http://json-schema.org/), that defines what is the allowed content of a JSON document + * The [JSON-schema specification](http://json-schema.org/draft-04/), that defines what is the allowed content of a JSON document * Fake data generators, that are used to generate basic or complex data, conforming to the schema. Since `v0.5.x` external generators are not longer bundled with jsf, however built-in defaults are shipped for all basic types and formats. @@ -232,13 +236,13 @@ Below is the list of supported keywords: - `$ref` — Resolve internal references only, and/or external if provided. - `required` — All required properties are guaranteed, if not can be omitted. - `pattern` — Generate samples based on RegExp values. -- `format` — Core formats only: - [`date-time`](http://json-schema.org/latest/json-schema-validation.html#anchor108), - [`email`](http://json-schema.org/latest/json-schema-validation.html#anchor111), - [`hostname`](http://json-schema.org/latest/json-schema-validation.html#anchor114), - [`ipv4`](http://json-schema.org/latest/json-schema-validation.html#anchor117), - [`ipv6`](http://json-schema.org/latest/json-schema-validation.html#anchor120) - and [`uri`](http://json-schema.org/latest/json-schema-validation.html#anchor123) +- `format` — Core formats **v4-draft only**: + [`date-time`](http://json-schema.org/draft-04/json-schema-validation.html#anchor108), + [`email`](http://json-schema.org/draft-04/json-schema-validation.html#anchor111), + [`hostname`](http://json-schema.org/draft-04/json-schema-validation.html#anchor114), + [`ipv4`](http://json-schema.org/draft-04/json-schema-validation.html#anchor117), + [`ipv6`](http://json-schema.org/draft-04/json-schema-validation.html#anchor120) + and [`uri`](http://json-schema.org/draft-04/json-schema-validation.html#anchor123) -- [demo ยป](http://json-schema-faker.js.org/#gist/f58db80cbf52c12c623166090240d964) - `enum` — Returns any of these enumerated values. - `minLength`, `maxLength` — Applies length constraints to string values. -- GitLab