release 1.0.0

Author: CarstenWickner

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## v1.0.0 – 2019-05-22
 ### Added
 - Indicate a field/method to be nullable if `@Null` is present
 - Indicate a field/method to be not nullable if `@NotNull`, `@NotEmpty` or `@NotBlank` is present
@@ -16,3 +18,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Indicate a number's "exclusiveMinimum" according to `@DecimalMin` or `@Positive`
 - Indicate a number's "maximum" (inclusive) according to `@Max`, `@DecimalMax` or `@NegativeOrZero`
 - Indicate a number's "exclusiveMaximum" according to `@DecimalMax` or `@Negative`
+
+[Unreleased]: https://github.com/victools/jsonschema-module-javax-validation/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/victools/jsonschema-module-javax-validation/releases/tag/v1.0.0

README.md

@@ -1,2 +1,49 @@
-# jsonschema-module-javax-validation
-Module for the `jsonschema-generator` – deriving JSON Schema attributes from `javax.validation` annotations
+# Java JSON Schema Generator – Module javax.validation
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.victools/jsonschema-module-javax-validation/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.victools/jsonschema-module-javax-validation)
+
+Module for the `jsonschema-generator` – deriving JSON Schema attributes from `javax.validation` annotations.
+
+## Usage
+### Dependency (Maven)
+
+```xml
+<dependency>
+    <groupId>com.github.victools</groupId>
+    <artifactId>jsonschema-module-javax-validation</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```
+
+### Code
+#### Passing into SchemaGeneratorConfigBuilder.with(Module)
+```java
+import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
+import com.github.victools.jsonschema.module.javax.validation.JavaxValidationModule;
+```
+```java
+JavaxValidationModule module = new JavaxValidationModule();
+SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(objectMapper)
+    .with(module);
+```
+
+#### Complete Example
+```java
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.github.victools.jsonschema.generator.OptionPreset;
+import com.github.victools.jsonschema.generator.SchemaGenerator;
+import com.github.victools.jsonschema.generator.SchemaGeneratorConfig;
+import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
+import com.github.victools.jsonschema.module.javax.validation.JavaxValidationModule;
+```
+```java
+ObjectMapper objectMapper = new ObjectMapper();
+JavaxValidationModule module = new JavaxValidationModule();
+SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(objectMapper, OptionPreset.PLAIN_JSON)
+    .with(module);
+SchemaGeneratorConfig config = configBuilder.build();
+SchemaGenerator generator = new SchemaGenerator(config);
+JsonNode jsonSchema = generator.generateSchema(YourClass.class);
+
+System.out.println(jsonSchema.toString());
+```

pom.xml

@@ -8,7 +8,7 @@
 
     <groupId>com.github.victools</groupId>
     <artifactId>jsonschema-module-javax-validation</artifactId>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.0</version>
     <packaging>jar</packaging>
 
     <licenses>
@@ -27,7 +27,7 @@
         <connection>scm:git:ssh://github.com/victools/jsonschema-module-javax-validation.git</connection>
         <developerConnection>scm:git:ssh://git@github.com/victools/jsonschema-module-javax-validation.git</developerConnection>
         <url>https://github.com/victools/jsonschema-module-javax-validation</url>
-        <tag>HEAD</tag>
+        <tag>v1.0.0</tag>
     </scm>
 
     <organization>