Skip to content

Commit

Permalink
Remove mentions of phar from README. Recommend dev dependency.
Browse files Browse the repository at this point in the history
  • Loading branch information
asm89 committed Aug 26, 2021
1 parent e5a829a commit 87828cc
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,7 @@ It can be useful to integrate in your ci setup or as the basis of editor plugins
Installation / Usage
--------------------

### As standalone executable

Download the [`twig-lint.phar`](https://asm89.github.io/d/twig-lint.phar) executable. Or as a global composer dependency:

```bash
composer global require "asm89/twig-lint" "@stable"
```

Run `php twig-lint.phar lint <file>` or `~/.composer/vendor/bin/twig-lint lint <file>`.

### As a dev dependency
### As a dev dependency (recommended)

Add the following to your `composer.json`:

Expand All @@ -34,13 +24,23 @@ Add the following to your `composer.json`:

Run `./bin/twig-lint lint <file>`.

### As standalone executable

Install as a global composer dependency:

```bash
composer global require "asm89/twig-lint" "@stable"
```

Run `~/.composer/vendor/bin/twig-lint lint <file>`.

### Vim and Syntastic configuration

For the standalone executable, add the following to your `~/.vimrc` file:

```vim
let g:syntastic_twig_twiglint_exec = 'php'
let g:syntastic_twig_twiglint_exe = 'php /path/to/twig-lint.phar'
let g:syntastic_twig_twiglint_exe = 'php /path/to/twig-lint'
```

For the composer dependency, twig-lint must be in your `$PATH`, no further
Expand Down

0 comments on commit 87828cc

Please sign in to comment.