Permalink
Browse files

readme: updated

  • Loading branch information...
dg committed Sep 26, 2017
1 parent 63d3fa7 commit 1c9b44992f1b52eeacd1de52a3442298503d3757
Showing with 18 additions and 3 deletions.
  1. +18 −3 readme.md
@@ -6,19 +6,34 @@ Code Checker
[![Latest Stable Version](https://poser.pugx.org/nette/code-checker/v/stable)](https://github.com/nette/code-checker/releases)
[![License](https://img.shields.io/badge/license-New%20BSD-blue.svg)](https://github.com/nette/code-checker/blob/master/license.md)


Introduction
------------

A simple tool to check source code against a set of Nette coding standards.

Code Checker requires PHP 5.4 or newer. The best way how to install is to use a [Composer](https://doc.nette.org/composer):
Documentation can be found on the [website](https://doc.nette.org/code-checker).


Installation
------------

The recommended way to install is via Composer:

```
composer create-project nette/code-checker
```

Note that this is a tool and not a library, so it cannot be installed using the command `composer require`.

Usage:
It requires PHP version 5.6 and supports PHP up to 7.2.


Usage
-----

```
php code-checker.php [options]
code-checker [options]
Options:
-d <path> folder to scan (default: current directory)

0 comments on commit 1c9b449

Please sign in to comment.