woocommerce/plugins/woocommerce-blocks/README.md

27 lines
1.4 KiB
Markdown
Raw Normal View History

2018-02-13 17:32:11 +00:00
Feature plugin for the Gutenberg Products block.
2018-04-20 17:17:55 +00:00
**Getting started with the stable version:**
1. The stable version is available on WordPress.org. You can get it [here](#updatethiswhenpluginislive).
2. Activate the plugin.
3. On Gutenberg posts you should now have a Products block available.
**Getting started with the development version:**
1. Make sure you have the latest version of the Gutenberg plugin and WooCommerce 3.3.1+ installed and active.
2018-02-13 17:32:11 +00:00
2. Get a copy of this plugin using the green "Clone or download" button on the right. Activate the plugin.
3. On Gutenberg posts you should now have a Products block available.
**Developers:**
2018-04-20 17:17:55 +00:00
1. Follow the "Getting started with the development version" instructions above.
2018-02-13 17:32:11 +00:00
2. `npm install` to install the compiler dependencies.
3. `npm run build-gutenberg` or `npm run build-gutenberg-watch` to compile the code.
The source code is in the products-block.jsx file and the compiled code is in products-block.js.
**Gutenberg Tutorial and Docs**: https://wordpress.org/gutenberg/handbook/blocks/
2018-04-20 17:17:55 +00:00
**Using API in Gutenberg**: https://github.com/WordPress/gutenberg/tree/213c64bb495946deffa3b6fe260f95b87de5774a/components/higher-order/with-api-data
### Vision for the Feature
2018-03-02 16:33:27 +00:00
Users should be able to insert a variety of products from their store (specific products, products in a category, with assorted layouts and visual styles, etc.) into their post content using a simple and powerful visual editor.