Skip to content

Commit f1749d1

Browse files
committed
Add READMEs to NPM Packages
1 parent b64e15f commit f1749d1

File tree

6 files changed

+94
-3
lines changed

6 files changed

+94
-3
lines changed

packages/cra-template-wptheme-typescript/README.md

+31
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,34 @@ For example:
99
```sh
1010
npx create-react-wptheme my-theme --typescript
1111
```
12+
13+
# Create React WP Theme
14+
15+
See the latest [README](https://github.com/devloco/create-react-wptheme) on Github.
16+
17+
18+
## Goals
19+
20+
- Remove WebPackDevServer and use your WordPress dev server instead.
21+
- Also, do not proxy the WordPress server.
22+
- Thus removing CORS as a concern.
23+
- Maintain feature parity(ish) with `create-react-app`
24+
- Touch the original `react-scripts` as little as possible.
25+
- Add new files where possible.
26+
- This will make merges easier.
27+
28+
## Acknowledgements
29+
30+
I'm grateful to the authors of existing related projects for their ideas and collaboration:
31+
32+
- [create-react-app](https://github.com/facebook/create-react-app)
33+
34+
The original.
35+
36+
- [filewatcher-webpack-plugin](https://www.npmjs.com/package/filewatcher-webpack-plugin)
37+
38+
I used this as an example for writing my own plugin for watching changes to the create-react-app "public" folder.
39+
40+
## License
41+
42+
Create React WP Theme is open source software [licensed as MIT](https://github.com/devloco/create-react-wptheme/blob/master/LICENSE).

packages/cra-template-wptheme-typescript/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cra-template-wptheme-typescript",
3-
"version": "3.3.0-wp.7",
3+
"version": "3.3.0-wp.8",
44
"keywords": [
55
"react",
66
"create-react-app",
+30
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
11
# cra-template-wptheme
22

33
This is the official base template for [Create React WPTheme](https://github.com/devloco/create-react-wptheme).
4+
5+
# Create React WP Theme
6+
7+
See the latest [README](https://github.com/devloco/create-react-wptheme) on Github.
8+
9+
## Goals
10+
11+
- Remove WebPackDevServer and use your WordPress dev server instead.
12+
- Also, do not proxy the WordPress server.
13+
- Thus removing CORS as a concern.
14+
- Maintain feature parity(ish) with `create-react-app`
15+
- Touch the original `react-scripts` as little as possible.
16+
- Add new files where possible.
17+
- This will make merges easier.
18+
19+
## Acknowledgements
20+
21+
I'm grateful to the authors of existing related projects for their ideas and collaboration:
22+
23+
- [create-react-app](https://github.com/facebook/create-react-app)
24+
25+
The original.
26+
27+
- [filewatcher-webpack-plugin](https://www.npmjs.com/package/filewatcher-webpack-plugin)
28+
29+
I used this as an example for writing my own plugin for watching changes to the create-react-app "public" folder.
30+
31+
## License
32+
33+
Create React WP Theme is open source software [licensed as MIT](https://github.com/devloco/create-react-wptheme/blob/master/LICENSE).

packages/cra-template-wptheme/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cra-template-wptheme",
3-
"version": "3.3.0-wp.3",
3+
"version": "3.3.0-wp.4",
44
"keywords": [
55
"wordpress",
66
"create-react-app",
+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Create React WP Theme
2+
3+
See the latest [README](https://github.com/devloco/create-react-wptheme) on Github.
4+
5+
6+
## Goals
7+
8+
- Remove WebPackDevServer and use your WordPress dev server instead.
9+
- Also, do not proxy the WordPress server.
10+
- Thus removing CORS as a concern.
11+
- Maintain feature parity(ish) with `create-react-app`
12+
- Touch the original `react-scripts` as little as possible.
13+
- Add new files where possible.
14+
- This will make merges easier.
15+
16+
## Acknowledgements
17+
18+
I'm grateful to the authors of existing related projects for their ideas and collaboration:
19+
20+
- [create-react-app](https://github.com/facebook/create-react-app)
21+
22+
The original.
23+
24+
- [filewatcher-webpack-plugin](https://www.npmjs.com/package/filewatcher-webpack-plugin)
25+
26+
I used this as an example for writing my own plugin for watching changes to the create-react-app "public" folder.
27+
28+
## License
29+
30+
Create React WP Theme is open source software [licensed as MIT](https://github.com/devloco/create-react-wptheme/blob/master/LICENSE).

packages/create-react-wptheme/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-react-wptheme",
3-
"version": "3.3.0-wp.6",
3+
"version": "3.3.0-wp.7",
44
"description": "Create React-enabled WP themes.",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)