Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hms5232 committed Nov 5, 2022
1 parent 9182c8f commit 53446fa
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# laravel-swagger
Render OpenAPI JSON or YAML with SwaggerUI in Laravel
Render [OpenAPI](https://www.openapis.org/) JSON or YAML with [SwaggerUI](https://swagger.io/tools/swagger-ui/) in Laravel.

## Usage

Expand All @@ -23,6 +23,8 @@ All configurable items are in `config/swagger.php` after you run publish command
php artisan vendor:publish --provider "Hms5232\LaravelSwagger\LaravelSwaggerServiceProvider"
```

If you want to override exists config file, excute command with `--force` flag.

See config file for detail information.

## Why another package
Expand All @@ -33,6 +35,8 @@ But exists projects are either using annotations or only supporting JSON (seems

So I develop this package, only have a view modified from [Swagger UI (unpkg)](https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/#unpkg), two routes to link documents.

> This section was written at version [0.1.0](https://github.com/hms5232/laravel-swagger/releases/tag/v0.1.0) and may be outdated in the future.
## LICENSE

[MIT](LICENSE)

0 comments on commit 53446fa

Please sign in to comment.