Skip to content

Commit fe4fa45

Browse files
dingo-djrfnl
andcommitted
Update readme of the project
Add the funding link and section in the readme. Add the link to the v3 release make post in the readme. Add the FUNDING.yml file so that we can add the funding button in the repo. Co-authored-by: Juliette <[email protected]>
1 parent 0cda979 commit fe4fa45

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
custom: ["https://opencollective.com/thewpcc/contribute/wp-php-63406", WP PHP]

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,17 @@
3939
* [Fixing errors or ignoring them](#fixing-errors-or-ignoring-them)
4040
+ [Tools shipped with WordPressCS](#tools-shipped-with-wordpresscs)
4141
* [Contributing](#contributing)
42+
* [Funding](#funding)
4243
* [License](#license)
4344

45+
---
4446

4547
## Introduction
4648

4749
This project is a collection of [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) rules (sniffs) to validate code developed for WordPress. It ensures code quality and adherence to coding conventions, especially the official [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/).
4850

51+
This project needs funding. If you want to donate read [here](#funding) about how you can help.
52+
4953
## Minimum Requirements
5054

5155
The WordPress Coding Standards package requires:
@@ -62,7 +66,7 @@ For the best results, it is recommended to also ensure the following additional
6266

6367
## Installation
6468

65-
As of WordPressCS 3.0.0, installation via Composer using the below instructions is the only supported type of installation.
69+
As of [WordPressCS 3.0.0](https://make.wordpress.org/core/2023/08/21/wordpresscs-3-0-0-is-now-available/), installation via Composer using the below instructions is the only supported type of installation.
6670

6771
[Composer](https://getcomposer.org/) will automatically install the project dependencies and register the rulesets from WordPressCS and other external standards with PHP_CodeSniffer using the [Composer PHPCS plugin](https://github.com/PHPCSStandards/composer-installer).
6872

@@ -248,6 +252,10 @@ At this moment, WordPressCS offer the following tools:
248252

249253
See [CONTRIBUTING](.github/CONTRIBUTING.md), including information about [unit testing](.github/CONTRIBUTING.md#unit-testing) the standard.
250254

255+
## Funding
256+
257+
If you want to sponsor the work on WordPressCS, you can do so by donating to the [WP PHP Open Collective](https://opencollective.com//thewpcc/contribute/wp-php-63406).
258+
251259
## License
252260

253261
See [LICENSE](LICENSE) (MIT).

0 commit comments

Comments
 (0)