From 14a067d584a3dea49539521350bf5f8225b87081 Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Fri, 2 Aug 2024 18:07:53 -0400 Subject: [PATCH] Bring usage section higher on the README Signed-off-by: Juan Cruz Viotti --- README.markdown | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.markdown b/README.markdown index 687309d..e1edd10 100644 --- a/README.markdown +++ b/README.markdown @@ -45,6 +45,24 @@ What our users are saying [@alombarte](https://github.com/alombarte), co-founder of the [KrakenD](https://www.krakend.io) API Gateway. +Usage +----- + +The functionality provided by the JSON Schema CLI is divided into commands. The +following pages describe each command in detail. Additionally, running the JSON +Schema CLI without passing a command will print convenient reference +documentation: + +- [`jsonschema validate`](./docs/validate.markdown) +- [`jsonschema metaschema`](./docs/metaschema.markdown) (ensure a schema is valid) +- [`jsonschema test`](./docs/test.markdown) (write unit tests for your schemas) +- [`jsonschema fmt`](./docs/format.markdown) +- [`jsonschema lint`](./docs/lint.markdown) +- [`jsonschema bundle`](./docs/bundle.markdown) (for inlining remote references in a schema) +- [`jsonschema frame`](./docs/frame.markdown) (for debugging references) +- [`jsonschema compile`](./docs/compile.markdown) (for internal debugging) +- [`jsonschema identify`](./docs/identify.markdown) + Installation ------------ @@ -132,24 +150,6 @@ cmake --install ./build --prefix \ Where `` can be any destination prefix of your choosing, such as `/opt` or `/usr/local`. -Usage ------ - -The functionality provided by the JSON Schema CLI is divided into commands. The -following pages describe each command in detail. Additionally, running the JSON -Schema CLI without passing a command will print convenient reference -documentation: - -- [`jsonschema validate`](./docs/validate.markdown) -- [`jsonschema metaschema`](./docs/metaschema.markdown) (ensure a schema is valid) -- [`jsonschema test`](./docs/test.markdown) (write unit tests for your schemas) -- [`jsonschema fmt`](./docs/format.markdown) -- [`jsonschema lint`](./docs/lint.markdown) -- [`jsonschema bundle`](./docs/bundle.markdown) (for inlining remote references in a schema) -- [`jsonschema frame`](./docs/frame.markdown) (for debugging references) -- [`jsonschema compile`](./docs/compile.markdown) (for internal debugging) -- [`jsonschema identify`](./docs/identify.markdown) - Coming Soon -----------