Skip to content

Commit

Permalink
docs: add usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
hanspagel committed Sep 9, 2024
1 parent 38da777 commit 25e879f
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,19 @@ php artisan vendor:publish --tag="scalar-views"

## Usage

TODO
You’ll need an OpenAPI/Swagger document to render your API reference with Scalar, here are two packages that help generating those documents:

* [knuckleswtf/scribe](https://github.com/knuckleswtf/scribe)
* [dedoc/scramble](https://github.com/dedoc/scramble)

Once done, you can pass it to Scalar:

```php
// config/scalar.php
return [
'url' => '/openapi.yaml',
]
```

## Testing

Expand Down

0 comments on commit 25e879f

Please sign in to comment.