diff --git a/README.md b/README.md index 7f33d34..3332d5d 100644 --- a/README.md +++ b/README.md @@ -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