Skip to content

Commit

Permalink
Update README.md and .editorconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
j13k committed Mar 27, 2018
1 parent a9a21f9 commit e5ad6fe
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
3 changes: 0 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,3 @@ indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit e5ad6fe

Please sign in to comment.