Skip to content

Commit ee5a6b6

Browse files
committed
updates readme
1 parent 6edfac3 commit ee5a6b6

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77

88
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.
99

10+
## Installation
11+
12+
`composer require codeb/wp-feature-flags`
13+
14+
Packagist: https://packagist.org/packages/codeb/wp-feature-flags
15+
1016
## Hooks
1117

1218
### PHP filters
@@ -89,10 +95,11 @@ CSS
8995
### PHP
9096

9197
- Run `./local` from your preferred CLI. Ensure you have Docker installed and running.
92-
- The setup will automatically ssh into the container.
93-
- To run unit tests `composer run test:unit`
94-
- To run integrations tests `composer run test:integration`
95-
- To run integrations tests as multisite `composer run test:multisite`
98+
The WordPress unit and integration tests depends on `wp-env` setup. Ensure you run `yarn wp-env:coverage` before running the tests.
99+
100+
- To run unit tests `yarn php:unit`
101+
- To run integrations tests `yarn php:integration`
102+
- To run integrations tests as multisite `yarn php:multisite`
96103

97104
### JS
98105

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,9 @@
6060
"jest-environment-jsdom": "^29.7.0",
6161
"prettier": "^3.2.5"
6262
},
63-
"keywords": []
63+
"keywords": [
64+
"feature flags",
65+
"wordpress",
66+
"plugin"
67+
]
6468
}

0 commit comments

Comments
 (0)