docs: document Maven and Gradle plugin usage in README

IN
1d ago
+65-1

Fixes #339

The README only described the CLI and the library, so the Maven and Gradle plugins that the project publishes to Maven Central were invisible to anyone landing on the repo page.

This adds:

  • a short note that the project ships as a CLI, a library, and Maven/Gradle plugins (the old wording said it was only a CLI and a library)
  • a "Using the Maven plugin" section: plugin coordinates, the validate goal (bound to the validate phase by default), direct invocation from the command line, and a pointer to the existing options table
  • a "Using the Gradle plugin" section: plugin id and coordinates, the openAPIStyleValidator task, and a buildscript-based setup — the plugin is on Maven Central but not the Gradle Plugin Portal, so the usual plugins {} block alone will not resolve it
  • a link to the sbt plugin maintained outside this project, as requested in the issue

Every snippet was checked against the current plugin sources: the mojo's validate goal and inputFile parameter, and the task name/configuration used by the gradle plugin's own functional test.


Summary by cubic

Documents the Maven and Gradle plugins in the README, which previously only described the CLI and the library. Fixes #339.

  • Adds "Using the Maven plugin" and "Using the Gradle plugin" sections with usage examples verified against the plugin sources.
  • Notes that the Gradle plugin is published to Maven Central but not the Gradle Plugin Portal.
  • Links the sbt plugin maintained outside this project.