Skip to content

Commit 926dec8

Browse files
committed
add note about local development to readme
1 parent 024e7f1 commit 926dec8

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,23 @@ Each project may optionally include an **ideasonpurpose.config.js** file in the
2929
3030
-->
3131

32+
## Local Development
33+
34+
Because this project makes use of bin scripts, conventional `npm link` workflows won't work correctly. To work on this code to work on a development project, change the project's package.json to install from a local file path, probably something like this:
35+
36+
```json
37+
"devDependencies": {
38+
"@ideasonpurpose/build-tools-wordpress": "../../build-tools-wordpress"
39+
}
40+
```
41+
42+
Running a simple watch script to re-install on changes will make things somewhat seamless:
43+
44+
```sh
45+
cd dev-project-working-dir
46+
npm chokidar-cli "../../build-tools-wordpress/**/*" -c "npm install"
47+
48+
3249
### Additional Notes
3350

3451
This project expects an entirely ES Module based environment and specifies all dependencies using standard ESM import syntax. Projects importing this file should set `"type": "module"` in their package.json files.
@@ -46,3 +63,4 @@ A GitHub action will auto-publish version-tagged releases to npm. In order to pu
4663
<a href="https://www.ideasonpurpose.com"><img src="https://raw.githubusercontent.com/ideasonpurpose/ideasonpurpose/master/iop-logo-white-on-black-88px.png" height="44" align="top" alt="IOP Logo"></a><img src="https://raw.githubusercontent.com/ideasonpurpose/ideasonpurpose/master/spacer.png" align="middle" width="4" height="54"> This project is actively developed and used in production at <a href="https://www.ideasonpurpose.com">Ideas On Purpose</a>.
4764

4865
<!-- END IOP CREDIT BLURB -->
66+
```

0 commit comments

Comments
 (0)