Skip to content

Commit 67536b6

Browse files
committed
Update readme
1 parent 050332a commit 67536b6

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
11
# Type Coverage Updater
2-
A helper script that helps you to auto-update the type coverage of this extension [Require Minimal Type Coverage
3-
](https://github.com/TomasVotruba/type-coverage)
2+
3+
## Overview
4+
Type Coverage Updater is a helper script designed to automatically update the type coverage
5+
of your PHP project, ensuring your codebase maintains a specified level of type safety.
6+
It works as an extension of [Tomas Votruba's type-coverage](https://github.com/TomasVotruba/type-coverage),
7+
automating the process of checking and updating the type coverage
8+
percentage in your project's configuration.
9+
10+
## Installation
11+
Install the package via Composer:
12+
13+
```bash
14+
composer require bellangelo/type-coverage-updater
15+
```
16+
17+
## Usage
18+
Run the updater script to automatically check and update the type coverage:
19+
20+
```bash
21+
vendor/bin/type-coverage-updater
22+
```
23+
This script will analyze your project, update the type coverage percentage in
24+
your configuration file, and ensure your codebase meets the specified type safety standards.

0 commit comments

Comments
 (0)