Skip to content

Commit

Permalink
Updated README.md with info regarding binaries.
Browse files Browse the repository at this point in the history
  • Loading branch information
j13k committed Dec 7, 2017
1 parent fc9be70 commit 343be41
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@
[![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

Via Composer:
Install as a project component with Composer (executable from the project's `vendor/bin` directory):

``` 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.

## Usage

``` bash
Expand Down

0 comments on commit 343be41

Please sign in to comment.