From a46e8aab214eb65ce04397b1a313342c6aa824c9 Mon Sep 17 00:00:00 2001 From: Elias Bouassaba Date: Tue, 9 Jul 2024 23:13:19 +0200 Subject: [PATCH] chore(webdav): update README.md --- webdav/README.md | 30 ++---------------------------- 1 file changed, 2 insertions(+), 28 deletions(-) diff --git a/webdav/README.md b/webdav/README.md index e80697a08..ba718dabe 100644 --- a/webdav/README.md +++ b/webdav/README.md @@ -1,4 +1,4 @@ -# Voltaserve Mosaic +# Voltaserve WebDAV Install [golangci-lint](https://github.com/golangci/golangci-lint). @@ -25,31 +25,5 @@ golangci-lint run Build Docker image: ```shell -docker build -t voltaserve/mosaic . -``` - -## Generate Documentation - -Format swag comments: - -```shell -swag fmt -``` - -Generate `swagger.yml`: - -```shell -swag init --output ./docs --outputTypes yaml -``` - -Preview (will be served at [http://localhost:19093](http://localhost:19093)): - -```shell -bunx @redocly/cli preview-docs --port 19095 ./docs/swagger.yaml -``` - -Generate the final static HTML documentation: - -```shell -bunx @redocly/cli build-docs ./docs/swagger.yaml --output ./docs/index.html +docker build -t voltaserve/webdav . ```