Skip to content

Commit 85b29b4

Browse files
committed
Update ReadMe.md
1 parent e4f325e commit 85b29b4

File tree

3 files changed

+32
-13
lines changed

3 files changed

+32
-13
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
/.gitignore export-ignore
44
/phpunit.xml.dist export-ignore
55
/README.md export-ignore
6+
/t.regx.png export-ignore

ReadMe.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,41 @@
1-
# Jasny PHPDoc parser
1+
<p align="center"><a href="https://t-regx.com/"><img src="t.regx.png"></a></p>
22

3-
[![Build status](https://github.com/jasny/phpdoc-parser/actions/workflows/php.yml/badge.svg)](https://github.com/jasny/phpdoc-parser/actions/workflows/php.yml)
4-
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/jasny/phpdoc-parser/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/jasny/phpdoc-parser/?branch=master)
5-
[![Code Coverage](https://scrutinizer-ci.com/g/jasny/phpdoc-parser/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/jasny/phpdoc-parser/?branch=master)
6-
[![Packagist Stable Version](https://img.shields.io/packagist/v/jasny/phpdoc-parser.svg)](https://packagist.org/packages/jasny/phpdoc-parser)
7-
[![Packagist License](https://img.shields.io/packagist/l/jasny/phpdoc-parser.svg)](https://packagist.org/packages/jasny/phpdoc-parser)
3+
# PhpDoc parser
84

9-
Configurable DocBlock parser from PHP.
5+
Lightweight parser of PhpDoc.
106

11-
Annotations aren't implemented in PHP itself which is why this component offers a way to use the PHP doc-blocks as a
12-
place for the well known tag syntax using the `@` char.
7+
[![Build Status](https://github.com/T-Regx/phpdoc-parser/workflows/build/badge.svg?branch=master)](https://github.com/T-Regx/phpdoc-parser/actions/)
8+
[![Coverage Status](https://coveralls.io/repos/github/T-Regx/phpdoc-parser/badge.svg?branch=master)](https://coveralls.io/github/T-Regx/phpdoc-parser?branch=master)
9+
[![Repository Size](https://github-size-badge.herokuapp.com/T-Regx/phpdoc-parser.svg)](https://github.com/T-Regx/phpdoc-parser)
10+
[![License](https://img.shields.io/github/license/T-Regx/phpdoc-parser.svg)](https://github.com/T-Regx/phpdoc-parser/blob/master/LICENSE)
11+
[![Composer lock](https://img.shields.io/badge/.lock-uncommited-green.svg)](https://github.com/T-Regx/phpdoc-parser)
1312

14-
The PHPDoc parser allows you to configure tags including the method how to parse and extract information. This
15-
is inline with phpDocumentor style annotations and differs from for instance Doctrine type annotations.
13+
[![PHP Version](https://img.shields.io/badge/PHP-7.1-blue.svg)][1]
14+
[![PHP Version](https://img.shields.io/badge/PHP-7.2-blue.svg)][1]
15+
[![PHP Version](https://img.shields.io/badge/PHP-7.3-blue.svg)][1]
16+
[![PHP Version](https://img.shields.io/badge/PHP-7.4-blue.svg)][1]
17+
[![PHP Version](https://img.shields.io/badge/PHP-8.0-blue.svg)][1]
18+
[![PHP Version](https://img.shields.io/badge/PHP-8.1-blue.svg)][1]
1619

17-
## Installation
20+
[1]: https://github.com/T-Regx/phpdoc-parser/runs/2375602376
21+
22+
[![PRs Welcome](https://img.shields.io/badge/PR-welcome-brightgreen.svg?style=popout)](http://makeapullrequest.com)
23+
24+
1. [Installation](#installation)
25+
* [Composer](#installation)
26+
2. [Usage](#usage)
27+
3. [Tags](#tags)
28+
4. [Tag classes](#tag-classes)
29+
5. [FQSEN Resolve](#fqsen-resolver)
30+
6. [Current limitations](#current-limitations)
31+
7. [Fixed from the original](#fixed-from-the-original)
32+
33+
# Installation
34+
35+
Installation for PHP 7.1 and later:
1836

1937
```bash
20-
composer require jasny/phpdoc-parser
38+
composer require rawr/phpdoc-parser
2139
```
2240

2341
## Usage

t.regx.png

32.2 KB
Loading

0 commit comments

Comments
 (0)