woocommerce/plugins/woocommerce-blocks
David Levin 57c5e08340 Merge pull request woocommerce/woocommerce-blocks#196 from woocommerce/update/readme-for-release
Update readme file
2018-12-03 16:24:14 -08:00
..
.github Update pull request template to add a11y instructions 2018-11-29 10:02:06 -05:00
assets Category Selection: Add loading & no results states (https://github.com/woocommerce/woocommerce-blocks/pull/197) 2018-12-03 19:17:22 -05:00
includes New custom endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/162) 2018-11-30 14:12:56 -05:00
tests Add tests for SearchListControl (https://github.com/woocommerce/woocommerce-blocks/pull/174) 2018-11-30 15:39:16 -05:00
.babelrc Update build process (https://github.com/woocommerce/woocommerce-blocks/pull/122) 2018-11-13 14:12:32 -05:00
.editorconfig Add .editorconfig file for editor integration (https://github.com/woocommerce/woocommerce-blocks/pull/128) 2018-11-16 10:42:56 -05:00
.eslintignore Update eslint config to ignore legacy block (https://github.com/woocommerce/woocommerce-blocks/pull/176) 2018-11-30 13:18:52 -05:00
.eslintrc.js Update eslint config to ignore legacy block (https://github.com/woocommerce/woocommerce-blocks/pull/176) 2018-11-30 13:18:52 -05:00
.gitattributes Add gitatributes file 2018-04-23 10:34:21 -07:00
.gitignore Update build process (https://github.com/woocommerce/woocommerce-blocks/pull/122) 2018-11-13 14:12:32 -05:00
.nvmrc Adds continuous integration testing with travis (https://github.com/woocommerce/woocommerce-blocks/pull/156) 2018-11-27 12:12:48 -05:00
.stylelintrc.json Add stylelint to find and fix css code style issues (https://github.com/woocommerce/woocommerce-blocks/pull/126) 2018-11-15 10:45:49 -05:00
.travis.yml Adds continuous integration testing with travis (https://github.com/woocommerce/woocommerce-blocks/pull/156) 2018-11-27 12:12:48 -05:00
README.md Update build process (https://github.com/woocommerce/woocommerce-blocks/pull/122) 2018-11-13 14:12:32 -05:00
composer.json Pin dependencies (https://github.com/woocommerce/woocommerce-blocks/pull/167) 2018-11-29 13:09:21 -05:00
composer.lock Pin dependencies (https://github.com/woocommerce/woocommerce-blocks/pull/167) 2018-11-29 13:09:21 -05:00
license.txt Readme 2018-04-20 10:17:55 -07:00
package-lock.json Category Selection: Add loading & no results states (https://github.com/woocommerce/woocommerce-blocks/pull/197) 2018-12-03 19:17:22 -05:00
package.json Category Selection: Add loading & no results states (https://github.com/woocommerce/woocommerce-blocks/pull/197) 2018-12-03 19:17:22 -05:00
phpcs.xml PHPCS (https://github.com/woocommerce/woocommerce-blocks/pull/163) 2018-11-29 10:23:04 -05:00
phpunit.xml.dist Adds continuous integration testing with travis (https://github.com/woocommerce/woocommerce-blocks/pull/156) 2018-11-27 12:12:48 -05:00
postcss.config.js Update build process (https://github.com/woocommerce/woocommerce-blocks/pull/122) 2018-11-13 14:12:32 -05:00
readme.txt Update the minimum requirements 2018-12-03 17:37:40 -05:00
renovate.json Add renovate.json (https://github.com/woocommerce/woocommerce-blocks/pull/127) 2018-11-15 16:55:12 -05:00
webpack.config.js Create a reusable search + list control for category selection (https://github.com/woocommerce/woocommerce-blocks/pull/166) 2018-11-29 13:10:08 -05:00
woocommerce-gutenberg-products-block.php New custom endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/162) 2018-11-30 14:12:56 -05:00

README.md

WooCommerce Product Blocks

Feature plugin for the Gutenberg Products block.

Getting started with the stable version:

  1. The stable version is available on WordPress.org. Download the stable version here.
  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
  • OR WordPress 5.0 (beta) and WooCommerce 3.5.1+
  1. Get a copy of this plugin using the green "Clone or download" button on the right.
  2. npm install to install the dependencies.
  3. npm run build (build once) or npm start (keep watching for changes) to compile the code.
  4. Activate the plugin.
  5. On Gutenberg posts & pages you should now have a "Products" block available.

The source code is in the assets/js/products-block.jsx file and the compiled code is in build/products-block.js.

Gutenberg Tutorial and Docs: https://wordpress.org/gutenberg/handbook/blocks/

Using API in Gutenberg: https://github.com/WordPress/gutenberg/tree/master/packages/api-fetch

Vision for the Feature

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.