From fe4fa457552d6618135726506d3877ce330f7d42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Denis=20=C5=BDoljom?= Date: Mon, 28 Aug 2023 14:32:20 +0200 Subject: [PATCH] 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 <663378+jrfnl@users.noreply.github.com> --- .github/FUNDING.yml | 1 + README.md | 10 +++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000000..f2427b9ed5 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +custom: ["https://opencollective.com/thewpcc/contribute/wp-php-63406", WP PHP] diff --git a/README.md b/README.md index 459adb0414..147eb5a18f 100644 --- a/README.md +++ b/README.md @@ -39,13 +39,17 @@ * [Fixing errors or ignoring them](#fixing-errors-or-ignoring-them) + [Tools shipped with WordPressCS](#tools-shipped-with-wordpresscs) * [Contributing](#contributing) +* [Funding](#funding) * [License](#license) +--- ## Introduction 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/). +This project needs funding. If you want to donate read [here](#funding) about how you can help. + ## Minimum Requirements The WordPress Coding Standards package requires: @@ -62,7 +66,7 @@ For the best results, it is recommended to also ensure the following additional ## Installation -As of WordPressCS 3.0.0, installation via Composer using the below instructions is the only supported type of installation. +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. [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). @@ -248,6 +252,10 @@ At this moment, WordPressCS offer the following tools: See [CONTRIBUTING](.github/CONTRIBUTING.md), including information about [unit testing](.github/CONTRIBUTING.md#unit-testing) the standard. +## Funding + +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). + ## License See [LICENSE](LICENSE) (MIT).