diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..26892da --- /dev/null +++ b/README.adoc @@ -0,0 +1,56 @@ + +# xbib Content + +image:https://api.travis-ci.org/xbib/content.svg[Build status] +image:https://img.shields.io/sonar/http/nemo.sonarqube.com/org.xbib%20content/coverage.svg?style=flat-square[Coverage] +image:https://maven-badges.herokuapp.com/maven-central/org.xbib/content/badge.svg[Maven Central] + +This is a Java library for processing structured data ("content") in the most popular formats, such as +JSON, SMILE-JSON, YAML, XML, CSV, and also semantic descriptions in RDF (N-Triples, Turtle, RDF/XML). + +xbib Content offers stream-based Java builders, parsers, and a settings API oder the formats, so it is very convenienant +to use. The only dependency is https://github.com/fasterxml/jackson[the Java Jackson library]. + +## Usage + +The library is provided by Maven Central repository. You can use the library with Gradle + +``` +dependencies { + compile "org.xbib:content-core:1.0.1" + compile "org.xbib:content-csv:1.0.1" + compile "org.xbib:content-json:1.0.1" + compile "org.xbib:content-language:1.0.1" + compile "org.xbib:content-rdf:1.0.1" + compile "org.xbib:content-resource:1.0.1" + compile "org.xbib:content-smile:1.0.1" + compile "org.xbib:content-xml:1.0.1" + compile "org.xbib:content-yaml:1.0.1" +} +``` + +or with Maven + +``` + + org.xbib + content-core + 1.0.1 + +``` + +# License + +Copyright (C) 2016 Jörg Prante + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +you may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file