Skip to content

Commit 4eed41b

Browse files
committed
minor readme improvements, initials of CONTRIBUTING.md
1 parent ed37fd9 commit 4eed41b

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Contributing guidelines
2+
=======================
3+
4+
Submitting bugreports
5+
---------------------
6+
7+
8+
9+
10+
Building the project locally
11+
----------------------------
12+
13+
Prerequisities: the following tools have to be installed:
14+
* jdk1.8.0_45 (earlier versions of javac cannot compile the project due to a type inference issue)
15+
* maven 3.x
16+
17+
18+
Steps for building the project:
19+
* clone the repository: `git clone https://github.com/everit-org/json-schema.git && cd json-schema/`
20+
* build it with maven: `mvn clean install`

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It uses the [org.json API](http://www.json.org/java/) (created by Douglas Crockf
66

77
When to use this library?
88
-------------------------
9-
Lets assume that you know what JSON Schema is, and you want to utilize it in a Java application to validate JSON data.
9+
Lets assume that you already know what JSON Schema is, and you want to utilize it in a Java application to validate JSON data.
1010
But - as you may have already discovered - there is also an [other Java implementation](https://github.com/fge/json-schema-validator)
1111
of the JSON Schema specification. So here are some advices about which one to use:
1212
* if you use Jackson to handle JSON in Java code, then fge/json-schema-validator is obviously a better choice, since it

0 commit comments

Comments
 (0)