Skip to content
Permalink
Browse files

added readme.md, updates

  • Loading branch information...
dg committed Feb 20, 2019
1 parent 465cb95 commit 1dd68b9ad2209d82e10729f0837735200b91a9c1
Showing with 55 additions and 2 deletions.
  1. +1 βˆ’1 composer.json
  2. +53 βˆ’0 readme.md
  3. +1 βˆ’1 src/bootstrap.php
@@ -1,6 +1,6 @@
{
"name": "nette/type-fixer",
"description": "πŸ†™ A tool to automatically update your code.",
"description": "πŸ†™ A tool to automatically update type hints in your PHP code.",
"type": "project",
"keywords": ["nette", "php 7", "type hints"],
"license": ["BSD-3-Clause"],
@@ -0,0 +1,53 @@
Nette TypeFixer πŸ†™
==================

[![Downloads this Month](https://img.shields.io/packagist/dm/nette/type-fixer.svg)](https://packagist.org/packages/nette/type-fixer)
[![Build Status](https://travis-ci.org/nette/type-fixer.svg?branch=master)](https://travis-ci.org/nette/type-fixer)
[![Latest Stable Version](https://poser.pugx.org/nette/type-fixer/v/stable)](https://github.com/nette/type-fixer/releases)
[![License](https://img.shields.io/badge/license-New%20BSD-blue.svg)](https://github.com/nette/type-fixer/blob/master/license.md)


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

A tool to automatically update type hints in your PHP code.

If you like Nette, **[please make a donation now](https://nette.org/donate)**. Thank you!


Usage
-----

```
typefixer [options] <directory>
Options:
-i | --ignore <mask> Directories to ignore
-f | --fix Fixes files
```

Example:

```
typefixer --fix /myproject
```


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

It requires PHP version 7.1 and supports PHP up to 7.3.

Install it via Composer. This project is not meant to be run as a dependency, so install it as standalone:

```
composer create-project nette/type-fixer
```

Or install it globally via:

```
composer global require nette/type-fixer
```

and make sure your global vendor binaries directory is in [your `$PATH` environment variable](https://getcomposer.org/doc/03-cli.md#global).
@@ -28,7 +28,7 @@
echo '
Nette Type Fixer v0.1
Nette Type Fixer v0.3
---------------------
';

0 comments on commit 1dd68b9

Please sign in to comment.
You can’t perform that action at this time.