Skip to content

Commit b5f3330

Browse files
committed
Update the README
Some things were a bit out of date. * Added missing files to the description list * Organized the list as it's getting a bit long * Removed the part about "archives" which is no longer true * Updated wording for "vocabulary" terminology * Other wording tweaks based on personal preference, since AFAIK the wording pre-dates the current group so I'm guessing no one will object too much. Feel free to do so if these were your words, the contributions part in particular is purely personal preference.
1 parent 04ee335 commit b5f3330

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@
22

33
JSON Schema is a vocabulary that allows you to validate, annotate, and manipulate JSON documents.
44

5-
This repository contains the sources for the **work in progress** of the next JSON Schema IETF Internet Draft (I-D) document.
6-
For released versions, please see the [Specification page](http://json-schema.org/documentation.html) on the website.
5+
This repository contains the sources for the **work in progress** of the next set of JSON Schema IETF Internet Draft (I-D) documents.
6+
For the latest released I-Ds, please see the [Specification page](http://json-schema.org/documentation.html) on the website.
77

8-
## Call for reviews
8+
## Call for contributions and feedback
99

10-
Reviews, comments and suggestions
11-
are of paramount importance to JSON Schema. It is humbly asked to you, dear
12-
reader, that you bring your contribution.
10+
Reviews, comments and suggestions are most welcome!
11+
Please read our [guidelines for contributing](CONTRIBUTING.md).
1312

1413
## Status
1514
For the current status of issues and pull requests, please see the following labels
@@ -24,12 +23,16 @@ Labels are assigned based on [Sensible Github Labels](https://github.com/Releque
2423
## Contents
2524

2625
* Makefile - scripts to build the Internet-Draft txt/html
27-
* archive/ - files for other/older JSON Schema implementations
28-
* hyper-schema.json - the JSON Hyper-schema meta-schema
29-
* schema.json - the JSON Schema meta-schema
30-
* jsonschema-core.xml - sources for "core" spec
31-
* jsonschema-validation.xml - sources for JSON Schema validation
32-
* jsonschema-hyperschema.xml - sources for hyper-schema spec
26+
* _Internet-Draft sources_
27+
* jsonschema-core.xml - source for JSON Schema's "core" I-D
28+
* jsonschema-validation.xml - source for the validation vocabulary I-D
29+
* jsonschema-hyperschema.xml - source for the hyper-schema vocabulary I-D
30+
* relative-json-pointer.xml - source for the Relative JSON Pointer I-D
31+
* _meta-schemas and recommended output formats_
32+
* schema.json - JSON Schema "core" and Validation meta-schema
33+
* hyper-schema.json - JSON Hyper-Schema meta-schema
34+
* links.json - JSON Hyper-Schema's Link Description Object meta-schema
35+
* hyper-schema-output.json - The recommended output format for JSON Hyper-Schema links
3336

3437
Type "make" at a shell to build the .txt and .html spec files.
3538

@@ -40,6 +43,11 @@ Descriptions of the xml2rfc, I-D documents, and RFC processes:
4043
* https://www.ietf.org/ietf-ftp/1id-guidelines.html
4144
* https://www.rfc-editor.org/rfc/rfc7322.txt
4245

46+
## Test suites
47+
48+
Conformance tests for JSON Schema and its vocabularies may be found
49+
[in their own repository](https://github.com/json-schema-org/JSON-Schema-Test-Suite).
50+
4351
## The website
4452

4553
The JSON Schema web site is at http://json-schema.org/

0 commit comments

Comments
 (0)