diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..0ce9256 --- /dev/null +++ b/README.adoc @@ -0,0 +1,58 @@ +:toc: macro +:toc-title: Read more: +:toclevels: 3 + + += Digipost XML + +Toolset helping with some of the cumbersome XML APIs of the JDK. + +Digipost XML consists of the following three libraries: + +- digipost-xml-*fundamentals*: offers some ergonomics on top of the standard XML APIs in the JDK. The baseline JDK requirement for this is Java 8, and there are not additional dependencies. +- digipost-xml-*bind-jakarta*: JAXB facilities, inspired by Spring OXM, and in addition contains a library of some useful adapters and other JAXB-related stuff. +- digipost-xml-*bind-javax*: This is identical to the above, but for the legacy `javax.xml.bind` namespace. It is, contrary to popular belief, possible to use these two JAXB variants side-by-side, should you need to, thanks to the almighty https://github.com/digipost/jaxb-resolver-com.sun.xml.bind[jaxb-resolver-com.sun.xml.bind]. + +toc::[] + +== How to use + +Declare the following in your `dependencyManagement` section + +[,xml] +---- + + + no.digipost.xml + digipost-xml-bom + [latest-version] + pom + import + + ... + +---- + +And depend on the part(s) you need. E.g: + +[,xml] +---- + + no.digipost.xml + digipost-xml-fundamentals + + + no.digipost.xml + digipost-xml-bind-jakarta + +---- + +== Digipost XML Fundamentals + +TODO + +== Digipost XML Bind (JAXB) + + +TODO +