Skip to content

Commit 7f3c253

Browse files
committed
Cleaned up some md files
1 parent c51b11e commit 7f3c253

File tree

4 files changed

+12
-20
lines changed

4 files changed

+12
-20
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919
- Started using a changelog.
2020
- Fixed bug that caused an infinite loop when no content found in tags.
2121
- Moved the Mock object to the tests directory, where it belongs.
22+
- Changes from `PSR-0` to `PSR-4` autoloading.
23+
- Updated `CONTRIBUTING.md` contents.

CONTRIBUTING.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,6 @@
22

33
This page contains guidelines for contributing to the PHPHtmlParser package. Please review these guidelines before submitting any puLl requests to the package.
44

5-
## Pull Requests
6-
7-
The pull request process differs for new features and bugs. Before sending a pull request for a new feature, you should first create an issue with `[Proposal]` in the title. The proposal should describe the new feature, as well as implementation ideas. The proposal will then be reviewed and either approved or denied. Once a proposal is approved, a pull request may be created implementing the new feature. Pull requests which do not follow this guideline will be closed immediately.
8-
9-
Pull requests for bugs may be sent without creating any proposal issue. If you believe that you know of a solution for a bug that has been filed on Github, please leave a comment detailing your proposed fix.
10-
11-
### Feature Requests
12-
13-
If you have an idea for a new feature you would like to see added to the package, you may create an issue on Github with `[Request]` in the title. The feature request will then be reviewed.
14-
155
## Coding Guidelines
166

17-
We follow the [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) autoloading standard and take heavily from the [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md) coding standards. In addition to these standards, below is a list of other coding standards that should be followed:
18-
19-
- Class opening `{` should be on the same line as the class name.
20-
- Function and control structure opening `{` should be on a separate line.
21-
- Interface names are suffixed with `Interface` (`FooInterface`)
7+
We follow the [PSR-4](https://www.php-fig.org/psr/psr-4/) autoloading standard and follow the [PSR-12](https://www.php-fig.org/psr/psr-12/) coding style guide. Please ensure you comply to these standards when creating a PR.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ PHPHtmlParser is a simple, flexible, html parser which allows you to select tags
1212
Install
1313
-------
1414

15+
Install the latest version using composer.
16+
17+
```bash
18+
$ composer require paquettg/php-html-parser
19+
```
20+
1521
This package can be found on [packagist](https://packagist.org/packages/paquettg/php-html-parser) and is best loaded using [composer](http://getcomposer.org/). We support php 7.1, 7.2, and 7.3.
1622

1723
Usage

composer.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@
2424
"php-coveralls/php-coveralls": "^2.1"
2525
},
2626
"autoload": {
27-
"psr-0": {
28-
"PHPHtmlParser": "src/"
27+
"psr-4": {
28+
"PHPHtmlParser\\": "src/PHPHtmlParser"
2929
}
30-
},
31-
"minimum-stability": "dev",
32-
"prefer-stable": true
30+
}
3331
}

0 commit comments

Comments
 (0)