Skip to content

Commit 9b14d38

Browse files
committed
Update README to be markdown, fix license, add badges.
1 parent 42ba970 commit 9b14d38

2 files changed

Lines changed: 50 additions & 36 deletions

File tree

README.markdown

Lines changed: 0 additions & 36 deletions
This file was deleted.

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
[![License LGPLv3][LGPLv3 badge]][LGPLv3]
2+
[![License ASL 2.0][ASL 2.0 badge]][ASL 2.0]
3+
[![Build Status][Travis badge]][Travis]
4+
[![Maven Central][Maven Central badge]][Maven]
5+
6+
## Read me first
7+
8+
This project, as of version 0.7, is licensed under both LGPLv3 and ASL 2.0. See
9+
file LICENSE for more details. Versions 0.6 and lower are licensed under LGPLv3
10+
only.
11+
12+
**Note the "L" in "LGPL". LGPL AND GPL ARE QUITE DIFFERENT!**
13+
14+
## What this is
15+
16+
This package contains sample demonstration processors based on [json-schema-core](https://github.com/java-json-tools/json-schema-core).
17+
18+
## List of processors
19+
20+
See [the wiki](https://github.com/fge/json-schema-processor-examples/wiki) for the list of processors, what software is used by each of them, etc.
21+
22+
Please note that at this moment, while all are functional, they are pretty basic.
23+
24+
Also note that as the time goes, some processors written in this package migrate to other,
25+
dedicated packages.
26+
27+
## Current version
28+
29+
The current version is **0.8**.
30+
31+
## Maven artifact
32+
33+
```xml
34+
<dependency>
35+
<groupId>com.github.java-json-tools</groupId>
36+
<artifactId>json-schema-processor-examples</artifactId>
37+
<version>your-version-here</version>
38+
</dependency>
39+
```
40+
41+
Versions before 0.9 are available at `groupId` `com.github.fge`.
42+
43+
[LGPLv3 badge]: https://img.shields.io/:license-LGPLv3-blue.svg
44+
[LGPLv3]: http://www.gnu.org/licenses/lgpl-3.0.html
45+
[ASL 2.0 badge]: https://img.shields.io/:license-Apache%202.0-blue.svg
46+
[ASL 2.0]: http://www.apache.org/licenses/LICENSE-2.0.html
47+
[Travis Badge]: https://api.travis-ci.org/java-json-tools/json-schema-processor-examples.svg?branch=master
48+
[Travis]: https://travis-ci.org/java-json-tools/json-schema-processor-examples
49+
[Maven Central badge]: https://img.shields.io/maven-central/v/com.github.java-json-tools/json-schema-processor-examples.svg
50+
[Maven]: https://search.maven.org/artifact/com.github.java-json-tools/json-schema-processor-examples

0 commit comments

Comments
 (0)