Skip to content

Commit ab39430

Browse files
authored
Merge pull request #76 from codebtech/chore/update-readme
updates readme
2 parents 6edfac3 + 0cf8ef4 commit ab39430

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

README.md

Lines changed: 11 additions & 5 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
@@ -88,11 +94,11 @@ CSS
8894

8995
### PHP
9096

91-
- 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`
97+
The WordPress unit and integration tests depends on `wp-env` setup. Ensure you run `yarn wp-env:coverage` before running the tests.
98+
99+
- To run unit tests `yarn php:unit`
100+
- To run integrations tests `yarn php:integration`
101+
- To run integrations tests as multisite `yarn php:multisite`
96102

97103
### JS
98104

package.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "codeb-feature-flags",
3-
"version": "0.3.1",
3+
"version": "0.3.2",
44
"description": "Allows developers to enable / disable features based on flags.",
55
"license": "ISC",
66
"author": "Mohan Raj <https://mohanraj.dev>",
@@ -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
}

plugin.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* Plugin Name: Feature Flags
1010
* Plugin URI: https://github.com/codebtech/wp-feature-flags
1111
* Description: Allows developers to enable / disable features based on flags.
12-
* Version: 0.3.1
12+
* Version: 0.3.2
1313
* Requires at least: 6.4
1414
* Requires PHP: 8.1
1515
* Author: Mohan Raj

0 commit comments

Comments
 (0)