Add READMEs to NPM Packages

devloco · Dec 26, 2019 · f1749d1 · f1749d1
1 parent b64e15f
commit f1749d1
Show file tree

Hide file tree

Showing 6 changed files with 94 additions and 3 deletions.
diff --git a/packages/cra-template-wptheme-typescript/README.md b/packages/cra-template-wptheme-typescript/README.md
@@ -9,3 +9,34 @@ For example:
 ```sh
 npx create-react-wptheme my-theme --typescript
 ```
+
+# Create React WP Theme
+
+See the latest [README](https://github.com/devloco/create-react-wptheme) on Github.
+
+
+## Goals
+
+-   Remove WebPackDevServer and use your WordPress dev server instead.
+    -   Also, do not proxy the WordPress server.
+    -   Thus removing CORS as a concern.
+-   Maintain feature parity(ish) with `create-react-app`
+-   Touch the original `react-scripts` as little as possible.
+    -   Add new files where possible.
+    -   This will make merges easier.
+
+## Acknowledgements
+
+I'm grateful to the authors of existing related projects for their ideas and collaboration:
+
+-   [create-react-app](https://github.com/facebook/create-react-app)
+
+    The original.
+
+-   [filewatcher-webpack-plugin](https://www.npmjs.com/package/filewatcher-webpack-plugin)
+
+    I used this as an example for writing my own plugin for watching changes to the create-react-app "public" folder.
+
+## License
+
+Create React WP Theme is open source software [licensed as MIT](https://github.com/devloco/create-react-wptheme/blob/master/LICENSE).
diff --git a/packages/cra-template-wptheme-typescript/package.json b/packages/cra-template-wptheme-typescript/package.json
@@ -1,6 +1,6 @@
 {
     "name": "cra-template-wptheme-typescript",
-    "version": "3.3.0-wp.7",
+    "version": "3.3.0-wp.8",
     "keywords": [
         "react",
         "create-react-app",

diff --git a/packages/cra-template-wptheme/README.md b/packages/cra-template-wptheme/README.md
@@ -1,3 +1,33 @@
 # cra-template-wptheme
 
 This is the official base template for [Create React WPTheme](https://github.com/devloco/create-react-wptheme).
+
+# Create React WP Theme
+
+See the latest [README](https://github.com/devloco/create-react-wptheme) on Github.
+
+## Goals
+
+-   Remove WebPackDevServer and use your WordPress dev server instead.
+    -   Also, do not proxy the WordPress server.
+    -   Thus removing CORS as a concern.
+-   Maintain feature parity(ish) with `create-react-app`
+-   Touch the original `react-scripts` as little as possible.
+    -   Add new files where possible.
+    -   This will make merges easier.
+
+## Acknowledgements
+
+I'm grateful to the authors of existing related projects for their ideas and collaboration:
+
+-   [create-react-app](https://github.com/facebook/create-react-app)
+
+    The original.
+
+-   [filewatcher-webpack-plugin](https://www.npmjs.com/package/filewatcher-webpack-plugin)
+
+    I used this as an example for writing my own plugin for watching changes to the create-react-app "public" folder.
+
+## License
+
+Create React WP Theme is open source software [licensed as MIT](https://github.com/devloco/create-react-wptheme/blob/master/LICENSE).
diff --git a/packages/cra-template-wptheme/package.json b/packages/cra-template-wptheme/package.json
@@ -1,6 +1,6 @@
 {
     "name": "cra-template-wptheme",
-    "version": "3.3.0-wp.3",
+    "version": "3.3.0-wp.4",
     "keywords": [
         "wordpress",
         "create-react-app",

diff --git a/packages/create-react-wptheme/README.md b/packages/create-react-wptheme/README.md
@@ -0,0 +1,30 @@
+# Create React WP Theme
+
+See the latest [README](https://github.com/devloco/create-react-wptheme) on Github.
+
+
+## Goals
+
+-   Remove WebPackDevServer and use your WordPress dev server instead.
+    -   Also, do not proxy the WordPress server.
+    -   Thus removing CORS as a concern.
+-   Maintain feature parity(ish) with `create-react-app`
+-   Touch the original `react-scripts` as little as possible.
+    -   Add new files where possible.
+    -   This will make merges easier.
+
+## Acknowledgements
+
+I'm grateful to the authors of existing related projects for their ideas and collaboration:
+
+-   [create-react-app](https://github.com/facebook/create-react-app)
+
+    The original.
+
+-   [filewatcher-webpack-plugin](https://www.npmjs.com/package/filewatcher-webpack-plugin)
+
+    I used this as an example for writing my own plugin for watching changes to the create-react-app "public" folder.
+
+## License
+
+Create React WP Theme is open source software [licensed as MIT](https://github.com/devloco/create-react-wptheme/blob/master/LICENSE).
diff --git a/packages/create-react-wptheme/package.json b/packages/create-react-wptheme/package.json
@@ -1,6 +1,6 @@
 {
     "name": "create-react-wptheme",
-    "version": "3.3.0-wp.6",
+    "version": "3.3.0-wp.7",
     "description": "Create React-enabled WP themes.",
     "main": "index.js",
     "scripts": {