From 3e4aa9f957d78eddb5d13743b9fce97454706483 Mon Sep 17 00:00:00 2001 From: "Andreas Penski (init)" Date: Fri, 29 May 2020 09:03:16 +0200 Subject: [PATCH] (chore) daemon documentation and license clarification for docsify --- src/main/resources/gui/README.md | 2 + src/main/resources/gui/docs/api.md | 1 + src/main/resources/gui/docs/configurations.md | 15 +++++ src/main/resources/gui/index.html | 56 +++++++++++-------- src/main/resources/gui/lib/License | 23 ++++++++ 5 files changed, 75 insertions(+), 22 deletions(-) create mode 100644 src/main/resources/gui/docs/configurations.md create mode 100644 src/main/resources/gui/lib/License diff --git a/src/main/resources/gui/README.md b/src/main/resources/gui/README.md index 7c3955f..40aad58 100644 --- a/src/main/resources/gui/README.md +++ b/src/main/resources/gui/README.md @@ -2,6 +2,8 @@ [API usage](docs/api) +[configurations](docs/configurations) + # Server information View [validator configuration](/server/config) or health information diff --git a/src/main/resources/gui/docs/api.md b/src/main/resources/gui/docs/api.md index dc84852..34d0c71 100644 --- a/src/main/resources/gui/docs/api.md +++ b/src/main/resources/gui/docs/api.md @@ -1,3 +1,4 @@ +# API Usage The validation service listens to `POST`-requests to any server uri. You need to supply the xml/object to validate in the post body. The service expects a single plain input in the post body, e.g. `multipart/form-data` is not supported. diff --git a/src/main/resources/gui/docs/configurations.md b/src/main/resources/gui/docs/configurations.md new file mode 100644 index 0000000..3e8678d --- /dev/null +++ b/src/main/resources/gui/docs/configurations.md @@ -0,0 +1,15 @@ +# Configurations + +The validator needs a scenario configuration for working properly. + +Currently, there are two public third party validation configurations available. + +* Validation Configuration for [XRechnung](http://www.xoev.de/de/xrechnung): + * Source code is available on [GitHub](https://github.com/itplr-kosit/validator-configuration-xrechnung) + * [Releases](https://github.com/itplr-kosit/validator-configuration-xrechnung/releases) can also be downloaded +* Validation Configuration for [XGewerbeanzeige](https://xgewerbeanzeige.de/) + * Source code is available on [GitHub](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige) + * [Releases](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige/releases) can also be downloaded + +For creating custom configurations see [configaration documentation](https://github.com/itplr-kosit/validator/blob/master/docs/configurations.md) +for details \ No newline at end of file diff --git a/src/main/resources/gui/index.html b/src/main/resources/gui/index.html index 4919302..1eb48c4 100644 --- a/src/main/resources/gui/index.html +++ b/src/main/resources/gui/index.html @@ -3,36 +3,48 @@ Validator - - - + + + + + diff --git a/src/main/resources/gui/lib/License b/src/main/resources/gui/lib/License new file mode 100644 index 0000000..4a5b531 --- /dev/null +++ b/src/main/resources/gui/lib/License @@ -0,0 +1,23 @@ +Sources in this diretory are based on https://github.com/docsifyjs/docsify/ + +MIT License + +Copyright (c) 2016 - present cinwell.li + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file