From 971aaa761bcc1b52d445ea308e0d75986f7bf984 Mon Sep 17 00:00:00 2001 From: Tatu Saloranta Date: Sat, 10 Jul 2021 16:03:20 -0700 Subject: [PATCH] Update README --- README.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 394d262b..8b1b1cd8 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ # Overview -The gold standard Stax XML API implementation. Now at Github. +The gold standard Stax XML API (`javax.xml.stream`) implementation. +Now at Github. + +For longer overview, check out: + +* [Java XML: Woodstox Introduction](https://www.studytrails.com/2016/09/12/java-xml-woodstox-introduction/) by StudyTrails ## Status -[![Build Status](https://travis-ci.org/FasterXML/woodstox.svg)](https://travis-ci.org/FasterXML/woodstox) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.woodstox/woodstox-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.woodstox/woodstox-core/) -[![Javadoc](https://javadoc.io/badge/com.fasterxml.woodstox/woodstox-core.svg)](http://www.javadoc.io/doc/com.fasterxml.woodstox/woodstox-core) -[![Coverage Status](https://coveralls.io/repos/github/FasterXML/woodstox/badge.svg?branch=master)](https://coveralls.io/github/FasterXML/woodstox?branch=master) -[![Tidelift](https://tidelift.com/badges/package/maven/com.fasterxml.woodstox:woodstox-core)](https://tidelift.com/subscription/pkg/maven-com-fasterxml-woodstox-woodstox-core?utm_source=maven-com-fasterxml-woodstox-woodstox-core&utm_medium=referral&utm_campaign=readme) +| Type | Status | +| ---- | ------ | +| Build (CI) | [![Build Status](https://travis-ci.org/FasterXML/woodstox.svg)](https://travis-ci.org/FasterXML/woodstox) | +| Artifact | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.woodstox/woodstox-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.woodstox/woodstox-core/) | +| OSS Sponsorship | [![Tidelift](https://tidelift.com/badges/package/maven/com.fasterxml.woodstox:woodstox-core)](https://tidelift.com/subscription/pkg/maven-com-fasterxml-woodstox-woodstox-core?utm_source=maven-com-fasterxml-woodstox-woodstox-core&utm_medium=referral&utm_campaign=readme) | +| Javadocs | [![Javadoc](https://javadoc.io/badge/com.fasterxml.woodstox/woodstox-core.svg)](http://www.javadoc.io/doc/com.fasterxml.woodstox/woodstox-core) +| CodeQ (LGTM.com) | [![LGTM alerts](https://img.shields.io/lgtm/alerts/g/FasterXML/woodstox.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FasterXML/woodstox/alerts/) [![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/FasterXML/woodstox.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FasterXML/woodstox/context:java) | # Get it! @@ -19,22 +26,22 @@ Coordinates for this are: * Group id: `com.fasterxml.woodstox` * Artifact id: `woodstox-core` -* Latest published version: 6.2.4 (2021-02-11) +* Latest published version: 6.2.6 (2021-04-19) -Note that Maven id has changed since Woodstox 4.x. +Note that Maven id has changed since Woodstox 4.x but API is still compatible (despite nominal major version upgrade -- major version upgrades in this case were only due to package coordinate changes) ## Requirements Woodstox 5 and above require Java 6 (JDK 1.6); as well as Stax API that is included in JDK. -The only other mandatory dependency is [Stax2 API](../../../stax2-api), extended API implemented by Woodstox -and some other Stax implementations (like [Aalto](../../../aalto-xml). +The only other mandatory dependency is [Stax2 API](../../../stax2-api), extended API implemented +by Woodstox and some other Stax implementations (like [Aalto](../../../aalto-xml). Optional dependency is [Multi-Schema Validator (MSV)](https://github.com/kohsuke/msv) that is needed if using XML Schema or RelaxNG validation functionality ## License -Woodstox 5.x is licensed under [Apache 2](http://www.apache.org/licenses/LICENSE-2.0.txt) license. +Woodstox 4.x and above licensed under [Apache 2](http://www.apache.org/licenses/LICENSE-2.0.txt) license. ## Documentation etc