Skip to content

Commit

Permalink
chore(webdav): update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bouassaba committed Jul 9, 2024
1 parent 09b19ca commit a46e8aa
Showing 1 changed file with 2 additions and 28 deletions.
30 changes: 2 additions & 28 deletions webdav/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Voltaserve Mosaic
# Voltaserve WebDAV

Install [golangci-lint](https://github.com/golangci/golangci-lint).

Expand All @@ -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 .
```

0 comments on commit a46e8aa

Please sign in to comment.