From e3a3d3af5cfc204fcbd2f33def9bcbaa8fc6068d Mon Sep 17 00:00:00 2001 From: Paul Sealock Date: Mon, 16 Nov 2020 13:04:53 +1300 Subject: [PATCH] create ext readme --- .../bin/starter-pack/README.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 plugins/woocommerce-admin/bin/starter-pack/README.md diff --git a/plugins/woocommerce-admin/bin/starter-pack/README.md b/plugins/woocommerce-admin/bin/starter-pack/README.md new file mode 100644 index 00000000000..2201ec1d538 --- /dev/null +++ b/plugins/woocommerce-admin/bin/starter-pack/README.md @@ -0,0 +1,24 @@ +# Create Extension + +Easily scaffold out a modern JavaScript WordPress plugin with WooCommerce tooling. + +## Includes + +- [wp-scripts](https://github.com/WordPress/gutenberg/tree/master/packages/scripts) +- [WooCommerce Dependency Extraction Webpack Plugin](https://github.com/woocommerce/woocommerce-admin/tree/main/packages/dependency-extraction-webpack-plugin) +- [WooCommerce ESLint Plugin with WordPress Prettier](https://github.com/woocommerce/woocommerce-admin/tree/main/packages/eslint-plugin) + +### Usage + +At the root of a [WooCommerce Admin](https://github.com/woocommerce/woocommerce-admin) installation, run the create extension command. + +``` +npm run create-wc-extension +``` + +The script will create a sibling directory with the a name of your choosing. Once you change directories into the new folder, install dependencies and start a development build. + +``` +npm install +npm start +```