Skip to content

Commit

Permalink
docs: Update installation instructions
Browse files Browse the repository at this point in the history
Signed-off-by: provokateurin <[email protected]>
  • Loading branch information
provokateurin committed Aug 21, 2024
1 parent 88e3470 commit 5c59f3b
Showing 1 changed file with 4 additions and 14 deletions.
18 changes: 4 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,12 @@

## Installation

This tool should be added as a dev dependency to the `composer.json` of your app (or in your `vendor-bin`) like this:

```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/nextcloud/openapi-extractor"
}
],
"require-dev": {
"nextcloud/openapi-extractor": "dev-main"
}
}
```sh
composer require --dev nextcloud/openapi-extractor
```

To avoid dependency and PHP version conflicts it is best to install the package to vendor-bin using https://github.com/bamarni/composer-bin-plugin instead.

## Create a CI workflow to check the specifications are up-to-date

The Workflow template repository has a template available: https://github.com/nextcloud/.github/blob/master/workflow-templates/openapi.yml
Expand Down

0 comments on commit 5c59f3b

Please sign in to comment.