|
1 |
| -# chillerlan/php-library-template |
| 1 | +# chillerlan/php-library-template-nodocs |
2 | 2 |
|
3 |
| -A template/boilerplate for PHP libraries. |
| 3 | +A template/boilerplate for PHP libraries (similar to [chillerlan/php-library-template](https://github.com/chillerlan/php-library-template) but without phpdocs and readthedocs deployment). |
4 | 4 |
|
5 | 5 | [![PHP Version Support][php-badge]][php]
|
6 | 6 | [![Packagist version][packagist-badge]][packagist]
|
7 | 7 | [![License][license-badge]][license]
|
8 | 8 | [![Continuous Integration][gh-action-badge]][gh-action]
|
9 | 9 | [![CodeCov][coverage-badge]][coverage]
|
10 |
| -[![Codacy][codacy-badge]][codacy] |
11 | 10 | [![Packagist downloads][downloads-badge]][downloads]
|
12 | 11 |
|
13 |
| -[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-library-template?logo=php&color=8892BF&logoColor=fff |
| 12 | +[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-library-template-nodocs?logo=php&color=8892BF&logoColor=fff |
14 | 13 | [php]: https://www.php.net/supported-versions.php
|
15 |
| -[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-library-template.svg?logo=packagist&logoColor=fff |
16 |
| -[packagist]: https://packagist.org/packages/chillerlan/php-library-template |
17 |
| -[license-badge]: https://img.shields.io/github/license/chillerlan/php-library-template |
18 |
| -[license]: https://github.com/chillerlan/php-library-template/blob/main/LICENSE |
19 |
| -[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-library-template/ci.yml?branch=main&logo=github&logoColor=fff |
20 |
| -[gh-action]: https://github.com/chillerlan/php-library-template/actions/workflows/ci.yml?query=branch%3Amain |
21 |
| -[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-library-template.svg?logo=codecov&logoColor=fff |
22 |
| -[coverage]: https://codecov.io/github/chillerlan/php-library-template |
23 |
| -[codacy-badge]: https://img.shields.io/codacy/grade/917022229a8f432e9a15481ebf0c587c?logo=codacy&logoColor=fff |
24 |
| -[codacy]: https://app.codacy.com/gh/chillerlan/php-library-template/dashboard |
25 |
| -[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-library-template.svg?logo=packagist&logoColor=fff |
26 |
| -[downloads]: https://packagist.org/packages/chillerlan/php-library-template/stats |
| 14 | +[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-library-template-nodocs.svg?logo=packagist&logoColor=fff |
| 15 | +[packagist]: https://packagist.org/packages/chillerlan/php-library-template-nodocs |
| 16 | +[license-badge]: https://img.shields.io/github/license/chillerlan/php-library-template-nodocs |
| 17 | +[license]: https://github.com/chillerlan/php-library-template-nodocs/blob/main/LICENSE |
| 18 | +[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-library-template-nodocs/ci.yml?branch=main&logo=github&logoColor=fff |
| 19 | +[gh-action]: https://github.com/chillerlan/php-library-template-nodocs/actions/workflows/ci.yml?query=branch%3Amain |
| 20 | +[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-library-template-nodocs.svg?logo=codecov&logoColor=fff |
| 21 | +[coverage]: https://codecov.io/github/chillerlan/php-library-template-nodocs |
| 22 | +[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-library-template-nodocs.svg?logo=packagist&logoColor=fff |
| 23 | +[downloads]: https://packagist.org/packages/chillerlan/php-library-template-nodocs/stats |
27 | 24 |
|
28 | 25 | ## Overview
|
29 | 26 |
|
30 | 27 | ### Features
|
31 | 28 |
|
32 |
| -- [GitHub Actions](https://github.com/chillerlan/php-library-template/actions) runner |
| 29 | +- [GitHub Actions](https://github.com/chillerlan/php-library-template-nodocs/actions) runner |
33 | 30 | - [Composer](https://getcomposer.org) dependency management
|
34 | 31 | - [PHPUnit](https://phpunit.de) unit tests
|
35 | 32 | - [PHAN](https://github.com/phan/phan) static analysis
|
36 | 33 | - [PHPCS](https://github.com/PHPCSStandards/PHP_CodeSniffer) coding standard analyzer
|
37 | 34 | - [PHPMD](https://phpmd.org) mess detector
|
38 | 35 | - [Codecov](https://codecov.io) code coverage analysis
|
39 |
| -- [Codacy](https://www.codacy.com) code quality analysis |
40 | 36 | - [phpDocumentor](https://www.phpdoc.org) auto generated API docs
|
41 |
| -- [ReadTheDocs](https://readthedocs.org) documentation builder |
42 | 37 |
|
43 | 38 |
|
44 | 39 | ### Requirements
|
45 | 40 |
|
46 | 41 | - PHP 8.1+
|
47 | 42 |
|
48 | 43 |
|
49 |
| -## Documentation |
50 |
| - |
51 |
| -- The user manual is at https://php-library-template.readthedocs.io/ ([sources](https://github.com/chillerlan/php-library-template/tree/main/docs)) |
52 |
| -- An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-library-template/ |
53 |
| - |
54 |
| - |
55 | 44 | ## Disclaimer
|
56 | 45 |
|
57 | 46 | Use at your own risk!
|
0 commit comments