diff --git a/README.md b/README.md index 2f869a3..b6636e9 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ packages. Please see for background information. +Command-line tools included with this standard are documented [here](./docs/tools.md). + The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this publication are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119). @@ -36,20 +38,6 @@ A package MUST use these names for these root-level files: A package SHOULD include a root-level file indicating the licensing and copyright terms of the package contents. -## Validator - -Quickly validate your project's compliance by following these steps: - -- Install package in your project: `composer require pds/skeleton @dev` -- Run the validator: `vendor/bin/pdsskeleton validate` - -## Generator - -Generate a compliant package skeleton by following these steps: - -- Install package in your project: `composer require pds/skeleton @dev` -- Run the generator: `vendor/bin/pdsskeleton generate` - ## Root-Level Directories ### bin/ diff --git a/docs/tools.md b/docs/tools.md new file mode 100644 index 0000000..4980d20 --- /dev/null +++ b/docs/tools.md @@ -0,0 +1,15 @@ +# Command-Line Tools + +## Validator + +Validate your project's compliance by following these steps: + +- Install package in your project: `composer require pds/skeleton @dev` +- Run the validator: `vendor/bin/pdsskeleton validate` + +## Generator + +Generate a compliant package skeleton by following these steps: + +- Install package in your project: `composer require pds/skeleton @dev` +- Run the generator: `vendor/bin/pdsskeleton generate`