Skip to content
This repository was archived by the owner on Feb 23, 2024. It is now read-only.

Commit 00d02fb

Browse files
authored
Improve readme.txt with note about nature of feature plugin (#2553)
* add improvements to readme.txt * some more tweaks to align with README.md * Fix up TOC * Remove errant “This.”
1 parent 79676ab commit 00d02fb

File tree

2 files changed

+30
-14
lines changed

2 files changed

+30
-14
lines changed

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,41 @@
1-
# WooCommerce Product Blocks
1+
# WooCommerce Product Blocks <!-- omit in toc -->
22

33
[![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)
44
[![Travis](https://travis-ci.com/woocommerce/woocommerce-gutenberg-products-block.svg?branch=master)](https://travis-ci.com/woocommerce/woocommerce-gutenberg-products-block)
55
[![View](https://img.shields.io/badge/Project%20Components-brightgreen.svg?style=flat)](https://woocommerce.github.io/woocommerce-gutenberg-products-block)
66

7-
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.
7+
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.
88

9-
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.
9+
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.
10+
11+
## Table of Contents <!-- omit in toc -->
12+
13+
- [Documentation](#documentation)
14+
- [Code Documentation](#code-documentation)
15+
- [Contributing](#contributing)
16+
- [Contributing](#contributing-1)
17+
- [Installing the stable version](#installing-the-stable-version)
18+
- [Installing the development version](#installing-the-development-version)
19+
- [Getting started with block development](#getting-started-with-block-development)
20+
- [Vision for the Feature](#vision-for-the-feature)
1021

1122
## Documentation
1223

1324
To find out more about the blocks and how to use them, [check out the documentation on WooCommerce.com](https://docs.woocommerce.com/document/woocommerce-blocks/).
1425

1526
If you want to see what we're working on for future versions, or want to help out, read on.
1627

17-
## Table of Contents
28+
### Code Documentation
29+
30+
- [Blocks](./assets/js/blocks)
31+
- [Components](assets/js/components)
32+
- [Other Docs](./docs)
33+
34+
### Contributing
35+
36+
- [Publishing a release](docs/releases/readme.md)
1837

19-
- [Installing the stable version](#installing-the-stable-version)
20-
- [Installing the development version](#installing-the-development-version)
21-
- [Getting started with block development](#getting-started-with-block-development)
22-
- [Contributing](docs)
23-
- [Publishing a release](docs/releases/readme.md)
24-
- Code Documentation
25-
- [Blocks](assets/js/blocks)
26-
- [Components](assets/js/components)
38+
## Contributing
2739

2840
## Installing the stable version
2941

readme.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
=== WooCommerce Blocks ===
22
Contributors: automattic, claudiulodro, tiagonoronha, jameskoster, ryelle, levinmedia, aljullu, mikejolley, nerrad, joshuawold, assassinateur, haszari
33
Tags: gutenberg, woocommerce, woo commerce, products, blocks, woocommerce blocks
4-
Requires at least: 5.0
5-
Tested up to: 5.3
4+
Requires at least: 5.2
5+
Tested up to: 5.4
66
Requires PHP: 5.6
77
Stable tag: 2.6.0-rc1
88
License: GPLv3
@@ -12,6 +12,10 @@ License URI: https://www.gnu.org/licenses/gpl-3.0.html
1212

1313
WooCommerce Blocks are the easiest, most flexible way to display your products on posts and pages!
1414

15+
**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.**
16+
17+
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.
18+
1519
**Featured Product Block**
1620
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.
1721

0 commit comments

Comments
 (0)