From a25cfaa0648526d1f67fa53e1b33b1786d443c09 Mon Sep 17 00:00:00 2001 From: Darren Ethier Date: Mon, 25 May 2020 09:39:21 -0400 Subject: [PATCH] Improve readme.txt with note about nature of feature plugin (https://github.com/woocommerce/woocommerce-blocks/pull/2553) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * add improvements to readme.txt * some more tweaks to align with README.md * Fix up TOC * Remove errant “This.” --- plugins/woocommerce-blocks/README.md | 36 ++++++++++++++++++--------- plugins/woocommerce-blocks/readme.txt | 8 ++++-- 2 files changed, 30 insertions(+), 14 deletions(-) diff --git a/plugins/woocommerce-blocks/README.md b/plugins/woocommerce-blocks/README.md index e32e80bc4b2..45ec3df649e 100644 --- a/plugins/woocommerce-blocks/README.md +++ b/plugins/woocommerce-blocks/README.md @@ -1,12 +1,23 @@ -# WooCommerce Product Blocks +# WooCommerce Product Blocks [![Latest Tag](https://img.shields.io/github/tag/woocommerce/woocommerce-gutenberg-products-block.svg?style=flat&label=Latest%20Tag)](https://github.com/woocommerce/woocommerce-gutenberg-products-block/releases) [![Travis](https://travis-ci.com/woocommerce/woocommerce-gutenberg-products-block.svg?branch=master)](https://travis-ci.com/woocommerce/woocommerce-gutenberg-products-block) [![View](https://img.shields.io/badge/Project%20Components-brightgreen.svg?style=flat)](https://woocommerce.github.io/woocommerce-gutenberg-products-block) -Feature plugin for WooCommerce + Gutenberg. This plugin serves as a space to iterate and explore new Blocks for WooCommerce, and how WooCommerce might work with the block editor. +Feature plugin for WooCommerce + Gutenberg. This plugin serves as a space to iterate and explore new Blocks and updates to existing blocks for WooCommerce, and how WooCommerce might work with the block editor. -If you're just looking to use these blocks, update to the latest version of WooCommerce! The blocks are bundled into WooCommerce since version 3.6, and can be added from the "WooCommerce" section in the block inserter. +Use this plugin if you want access to the bleeding edge of available blocks for WooCommerce. However, stable blocks are bundled into WooCommerce, and can be added from the "WooCommerce" section in the block inserter. + +## Table of Contents + +- [Documentation](#documentation) + - [Code Documentation](#code-documentation) + - [Contributing](#contributing) +- [Contributing](#contributing-1) +- [Installing the stable version](#installing-the-stable-version) +- [Installing the development version](#installing-the-development-version) +- [Getting started with block development](#getting-started-with-block-development) +- [Vision for the Feature](#vision-for-the-feature) ## Documentation @@ -14,16 +25,17 @@ To find out more about the blocks and how to use them, [check out the documentat If you want to see what we're working on for future versions, or want to help out, read on. -## Table of Contents +### Code Documentation -- [Installing the stable version](#installing-the-stable-version) -- [Installing the development version](#installing-the-development-version) -- [Getting started with block development](#getting-started-with-block-development) -- [Contributing](docs) - - [Publishing a release](docs/releases/readme.md) -- Code Documentation - - [Blocks](assets/js/blocks) - - [Components](assets/js/components) +- [Blocks](./assets/js/blocks) +- [Components](assets/js/components) +- [Other Docs](./docs) + +### Contributing + +- [Publishing a release](docs/releases/readme.md) + +## Contributing ## Installing the stable version diff --git a/plugins/woocommerce-blocks/readme.txt b/plugins/woocommerce-blocks/readme.txt index 94afd004bfb..6b94e123614 100644 --- a/plugins/woocommerce-blocks/readme.txt +++ b/plugins/woocommerce-blocks/readme.txt @@ -1,8 +1,8 @@ === WooCommerce Blocks === Contributors: automattic, claudiulodro, tiagonoronha, jameskoster, ryelle, levinmedia, aljullu, mikejolley, nerrad, joshuawold, assassinateur, haszari Tags: gutenberg, woocommerce, woo commerce, products, blocks, woocommerce blocks -Requires at least: 5.0 -Tested up to: 5.3 +Requires at least: 5.2 +Tested up to: 5.4 Requires PHP: 5.6 Stable tag: 2.6.0-rc1 License: GPLv3 @@ -12,6 +12,10 @@ License URI: https://www.gnu.org/licenses/gpl-3.0.html WooCommerce Blocks are the easiest, most flexible way to display your products on posts and pages! +**Note: Feature plugin for WooCommerce + Gutenberg. This plugin serves as a space to iterate and explore new Blocks and updates to existing blocks for WooCommerce, and how WooCommerce might work with the block editor.** + +Use this plugin if you want access to the bleeding edge of available blocks for WooCommerce. However, stable blocks are bundled into WooCommerce, and can be added from the "WooCommerce" section in the block inserter. + **Featured Product Block** Select and display a single product in a new, high impact fashion. Control text alignment, hide or show the price and description, add a color overlay, change the button call to action, and override the product photo.