Skip to content

Commit c0dedc6

Browse files
authored
Update README.md
1 parent 0c742d3 commit c0dedc6

File tree

1 file changed

+30
-22
lines changed

1 file changed

+30
-22
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,49 @@
1-
Extension Pre-Validator
2-
=======================
1+
# Extension Pre-Validator
32

43
[![Build Status](https://github.com/phpbb/epv/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbb/epv/actions)
54

65
This repository contains the extension pre-validator, used for pre validating extensions when submittion to the database at phpBB.com.
76

8-
Please note that EPV requires at least PHP 5.5
7+
Please note that EPV requires at least PHP 7.2
98

10-
Using EPV
11-
---------
12-
13-
1. Clone the repository
14-
1. Run:
9+
## Using EPV
1510

11+
1. Clone your fork of this repository.
12+
2. Install composer dependencies:
13+
```sh
1614
$ php composer.phar install
15+
```
16+
3. Run EPV on a phpBB extension from the CLI:
17+
```sh
18+
# Run EPV on a Git repository (at any repository hosting site)
19+
php src/EPV.php run --git="https://github.com/repo-org/repo-name.git"
1720
18-
1. You can run EPV on three different methods from the CLI:
19-
* php src/EPV.php run --git="GIT_REPO"
20-
* php src/EPV.php run --github="GITHUB_NAME"
21-
* php src/EPV.php run --dir="LOCAL DIRECTORY"
22-
1. You can use the --debug option to get some debug information.
23-
1. You can also use EPV from soon [phpBB.com](https://www.phpbb.com/extensions/epv/)
24-
1. Titania will check when submitting to phpBB.com using EPV as well.
21+
# Run EPV on a GitHub repository
22+
php src/EPV.php run --github="repo-org/repo-name"
2523
26-
License
27-
-------
28-
[GNU GPL v2](http://opensource.org/licenses/gpl-2.0)
24+
# Run EPV on a local directory
25+
php src/EPV.php run --dir="/path/to/extension"
26+
```
2927

30-
By contributing you agree to assign copyright of your code to phpBB Limited.
28+
> The `--branch` option can target a specific branch of a repository.
29+
>
30+
> The `--debug` option will output additional debugging information.
3131

32-
See `LICENSE` for the full license.
32+
You can also use EPV online at [phpBB.com](https://www.phpbb.com/extensions/epv/)
3333

34-
Maintenance and contributing
35-
----------------------------
34+
phpBB's Customisation Database (Titania) will run EPV on any submissions at phpBB.com as well.
35+
36+
## Maintenance and contributing
3637
3738
To contribute fork the repo, make your changes in a feature branch and send a pull request.
3839
3940
The site is maintained by the [phpBB Extensions Team](https://www.phpbb.com/community/memberlist.php?mode=group&g=7331)
4041
4142
Should you wish to report a bug report it at [Issue tracker](https://github.com/phpbb/epv/issues)
43+
44+
## License
45+
[GNU General Public License v2](https://opensource.org/licenses/GPL-2.0)
46+
47+
By contributing you agree to assign copyright of your code to phpBB Limited.
48+
49+
See `LICENSE` for the full license.

0 commit comments

Comments
 (0)