update docs

Author: hauner

README.adoc

@@ -73,13 +73,13 @@ A "bill of materials" POM for json-schema-validator dependencies.
 
 link:{central-search}[image:{jackson-central-badge}[]]
 
-json/yaml `Reader` & `Converter` based on link:{jackson}[Jackson].
+json/yaml `Reader`, `Writer` & `Converter` based on link:{jackson}[Jackson].
 
 === link:{converter-snakeyaml}[io-snakeyaml]
 
 link:{central-search}[image:{snakeyaml-central-badge}[]]
 
-yaml `Reader` & `Converter` based on link:{snakeyaml}[snakeyaml].
+yaml `Reader`, `Writer` & `Converter` based on link:{snakeyaml}[snakeyaml].
 
 === link:{io-interfaces}[io-interfaces]
 

io-interfaces/README.adoc

@@ -1,5 +1,6 @@
 :converter: https://github.com/openapi-processor/openapi-parser/blob/master/io-interfaces/src/main/java/io/openapiprocessor/interfaces/Converter.java
 :reader: https://github.com/openapi-processor/openapi-parser/blob/master/io-interfaces/src/main/java/io/openapiprocessor/interfaces/Reader.java
+:writer: https://github.com/openapi-processor/openapi-parser/blob/master/io-interfaces/src/main/java/io/openapiprocessor/interfaces/Writer.java
 
 :support: https://github.com/openapi-processor/openapi-parser/tree/master/json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/reader
 :converter-jackson: https://github.com/openapi-processor/openapi-parser/tree/master/io-jackson
@@ -17,6 +18,12 @@ the link:{reader}[`Reader`] interface is used to read OpenAPI json/yaml document
 
     InputStream read(URI uri) throws IOException;
 
+== Reader
+
+the link:{writer}[`Writer`] interface is used to write OpenAPI json/yaml documents:
+
+    void write(Object document) throws IOException;
+
 == Converter
 
 the link:{converter}[`Converter`] interface is used to convert a json/yaml document into a java `Object` tree. The tree structure should be  a `Map<String, Object>`.

openapi-parser/README.adoc

@@ -1,4 +1,5 @@
 :openapi: https://www.openapis.org/
+:overlay: https://spec.openapis.org/overlay/v1.0.0.html
 :converter-jackson: https://github.com/openapi-processor/openapi-parser/tree/master/io-jackson
 :converter-snakeyaml: https://github.com/openapi-processor/openapi-parser/tree/master/io-snakeyaml
 
@@ -9,7 +10,7 @@ It is usable, but has the following limitations at the moment:
 * it does support most but not all OpenAPI object properties
 * minimal documentation (just this README)
 
-source code gifts (i.e pull requests) are welcome :-)
+source code gifts (i.e. pull requests) are welcome :-)
 
 == openapi-parser & validator
 
@@ -21,6 +22,9 @@ a Java 11 based link:{openapi}[OpenAPI] 3.0.x & 3.1 parser with validation and p
 ** JSON schema draft-2020-12 validation of OpenAPI 3.1
 * separate apis for OpenAPI 3.0 & 3.1
 * easily get resolved $ref object
+* bundle multi-file OpenAPI documents (experimental)
+* write bundled single-file OpenAPI document (json or yaml) (experimental)
+// * apply link:{overlay}[Overlays] (experimental)
 * minimal dependencies
 * pluggable document reader
 * pluggable json/yaml converter