Skip to content

Commit

Permalink
Update readme of the project
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
dingo-d and jrfnl committed Sep 9, 2023
1 parent 0cda979 commit fe4fa45
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
custom: ["https://opencollective.com/thewpcc/contribute/wp-php-63406", WP PHP]
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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).

Expand Down Expand Up @@ -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).

0 comments on commit fe4fa45

Please sign in to comment.