Skip to content
This repository has been archived by the owner on Jun 29, 2023. It is now read-only.

Commit

Permalink
docs(Readme): Add docs for npx
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonkramer committed Jan 14, 2021
1 parent 4437d6f commit fb1d376
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,21 +120,25 @@ the class. The idea of this organisation is to be more conscious of structuring
### PHPCodeSniffer

- Run PHPCodeSniffer with `composer phpcs` to validate your plugin code
- Configure PHPCodeSniffer in `phpcs.xm.dist`
- Configure PHPCodeSniffer in `phpcs.xm.dist`
- Documentation can be found here:
- https://github.com/WordPress/WordPress-Coding-Standards
- https://github.com/Dealerdirect/phpcodesniffer-composer-installer
- https://github.com/Automattic/phpcs-neutron-ruleset
- https://github.com/PHPCompatibility/PHPCompatibilityWP
- https://github.com/WordPress/WordPress-Coding-Standards
- https://github.com/Dealerdirect/phpcodesniffer-composer-installer
- https://github.com/Automattic/phpcs-neutron-ruleset
- https://github.com/PHPCompatibility/PHPCompatibilityWP

### Plugin requirements
- Set your plugin requirements in `classes/Config/Requirements.php` using a simple array
- It can test: PHP version, PHP Extensions, WordPress version, Active plugins, Current theme, DocHooks support
- If the plugin doesn't pass the test then it will be disabled automatically in WordPress and show a notification in the back-end
- Documentation can be found here: https://github.com/micropackage/requirements

### TravisCI
- Configure TravisCI in `.travis.yml`
- Currently it only validates the plugin code with PHPCodeSniffer during automated testing when being deployed
- A great article can be found here: https://stevegrunwell.com/blog/travis-ci-wordpress-plugins/

## Frontend tooling
## Frontend/Webpack tooling
When using webpack then you can use the following for the front-end build process. ([Or read more here](https://github.com/wp-strap/wordpress-webpack-workflow))

### Developing Locally
Expand Down

0 comments on commit fb1d376

Please sign in to comment.