Skip to content

Commit bdc1edb

Browse files
authored
Merge pull request #178 from codebtech/chore/update-readme-wp
update readme
2 parents feb9ae5 + f9f9e74 commit bdc1edb

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77

88
Stable tag: 0.3.2
99
Requires at least: 6.2
10-
Tested up to: 6.4
10+
Tested up to: 6.6
1111
Requires PHP: 8.1
1212

13-
WordPress Feature flags plugin allow developers to configure features in plugins/themes behind the feature flags on both the server (PHP) and client (JS/TS) side.
13+
WordPress Feature flags plugin allow developers to configure features in plugins/themes behind the feature flags on both
14+
the server (PHP) and client (JS/TS) side.
1415

1516
## Installation
1617

@@ -61,60 +62,63 @@ To build the plugin
6162

6263
PHP setup
6364

64-
- `composer install`
65+
- `composer install`
6566

6667
JS setup
6768

68-
- `yarn install`
69-
- `yarn build` to create the build
70-
- `yarn start` to start the watch mode
69+
- `yarn install`
70+
- `yarn build` to create the build
71+
- `yarn start` to start the watch mode
7172

7273
### wp-env
7374

7475
This plugin uses `wp-env` setup to for local environment.
7576

76-
- `wp-env start` to start the containers
77-
- `wp-env stop` to stop the containers
77+
- `wp-env start` to start the containers
78+
- `wp-env stop` to stop the containers
7879

79-
More details on how to access local environment can be found [here](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#quick-tldr-instructions).
80+
More details on how to access local environment can be
81+
found [here](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#quick-tldr-instructions).
8082

8183
## Linting and formatting
8284

8385
PHP
8486

85-
- `composer lint`
86-
- `composer lint:fix` to auto fix PHP linting errors.
87+
- `composer lint`
88+
- `composer lint:fix` to auto fix PHP linting errors.
8789

8890
JS
8991

90-
- `yarn lint:js`
91-
- `yarn lint:js:fix` to auto fix JS linting errors.
92+
- `yarn lint:js`
93+
- `yarn lint:js:fix` to auto fix JS linting errors.
9294

9395
CSS
9496

95-
- `yarn lint:css`
96-
- `yarn lint:css:fix` to auto fix CSS linting errors.
97+
- `yarn lint:css`
98+
- `yarn lint:css:fix` to auto fix CSS linting errors.
9799

98100
## Testing
99101

100102
### PHP
101103

102-
The WordPress unit and integration tests depends on `wp-env` setup. Ensure you run `yarn wp-env:coverage` before running the tests.
104+
The WordPress unit and integration tests depends on `wp-env` setup. Ensure you run `yarn wp-env:coverage` before running
105+
the tests.
103106

104-
- To run unit tests `yarn php:unit`
105-
- To run integrations tests `yarn php:integration`
106-
- To run integrations tests as multisite `yarn php:multisite`
107+
- To run unit tests `yarn php:unit`
108+
- To run integrations tests `yarn php:integration`
109+
- To run integrations tests as multisite `yarn php:multisite`
107110

108111
### JS
109112

110-
- Run `yarn test:js` to run all Jest and React Testing Library tests
113+
- Run `yarn test:js` to run all Jest and React Testing Library tests
111114

112115
### E2E
113116

114117
The E2E tests depends on `wp-env` setup. Ensure you run `wp-env start` before running the tests.
115118

116-
- Run `yarn test:e2e` to run all Playwright e2e tests.
119+
- Run `yarn test:e2e` to run all Playwright e2e tests.
117120

118121
## Contributing
119122

120-
Code contributions, feedback, issue reporting and feature suggestions are welcome. See [CONTRIBUTING.md](https://github.com/codebtech/wp-feature-flags/blob/main/CONTRIBUTING.md) for more details.
123+
Code contributions, feedback, issue reporting and feature suggestions are welcome.
124+
See [CONTRIBUTING.md](https://github.com/codebtech/wp-feature-flags/blob/main/CONTRIBUTING.md) for more details.

0 commit comments

Comments
 (0)