From e5ad6fee2df800d65bd83e65c680296575bf9d93 Mon Sep 17 00:00:00 2001 From: John Fitzpatrick Date: Tue, 27 Mar 2018 17:06:05 +1100 Subject: [PATCH] Update README.md and .editorconfig * Added usage text to clarify issue raised in #7. * Adjustments to address: - https://github.com/DavidAnson/markdownlint/blob/v0.8.1/doc/Rules.md#md013 - https://github.com/DavidAnson/markdownlint/blob/v0.8.1/doc/Rules.md#md014 --- .editorconfig | 3 --- README.md | 25 ++++++++++++++++--------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/.editorconfig b/.editorconfig index cd8eb86..48542cb 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,6 +10,3 @@ indent_style = space end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true - -[*.md] -trim_trailing_whitespace = false diff --git a/README.md b/README.md index 4edb89f..fac0b70 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,26 @@ [![Scrutinizer Code Quality][ico-code-quality]][link-code-quality] [![Dependency Status][ico-dependencies]][link-dependencies] -A compact command line utility for checking YAML file syntax. Uses the parsing facility of the -[Symfony Yaml Component](https://github.com/symfony/yaml). +A compact command line utility for checking YAML file syntax. Uses the parsing +facility of the [Symfony Yaml Component](https://github.com/symfony/yaml). ## Install -Install as a project component with Composer (executable from the project's `vendor/bin` directory): +Install as a project component with Composer (executable from the project's + `vendor/bin` directory): -``` bash -$ composer require j13k/yaml-lint +```bash +composer require j13k/yaml-lint ``` -Typically a binary edition (`yaml-lint.phar`) is also available for download with [each release](https://github.com/j13k/yaml-lint/releases). -This embeds the latest stable version of the Symfony Yaml component that is current at the time of the release. +Typically a binary edition (`yaml-lint.phar`) is also available for download +with [each release](https://github.com/j13k/yaml-lint/releases). This embeds +the latest stable version of the Symfony Yaml component that is current at +the time of the release. ## Usage -``` bash +```text usage: yaml-lint [options] [input source] input source Path to file, or "-" to read from standard input @@ -32,9 +35,13 @@ usage: yaml-lint [options] [input source] -V, --version Display application version ``` +Note that only _single files_ or standard input are currently supported, with +support for multiple files planned for a future release. + ## Change log -Please see [CHANGELOG](CHANGELOG.md) for information on what has changed recently. +Please see [CHANGELOG](CHANGELOG.md) for information on what has +changed recently. ## Credits