Skip to content

Commit 0820dd8

Browse files
committed
Update README.txt
1 parent 9cbb5a4 commit 0820dd8

1 file changed

Lines changed: 36 additions & 89 deletions

File tree

README.txt

Lines changed: 36 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,61 @@
1-
=== Plugin Name ===
2-
Contributors: (this should be a list of wordpress.org userid's)
3-
Donate link: https://woocommerce.com
4-
Tags: comments, spam
5-
Requires at least: 3.0.1
6-
Tested up to: 3.4
7-
Stable tag: 4.3
8-
License: GPLv2 or later
9-
License URI: http://www.gnu.org/licenses/gpl-2.0.html
10-
11-
Here is a short description of the plugin. This should be no more than 150 characters. No markup here.
1+
=== Pinterest for WooCommerce ===
2+
Contributors: automattic, pinterest, woocommerce
3+
Tags: woocommerce, pinterest, advertise
4+
Requires at least: 5.6
5+
Tested up to: 5.8
6+
Requires PHP: 7.3
7+
Stable tag: 1.0.0-beta.3
8+
License: GPLv3
9+
License URI: https://www.gnu.org/licenses/gpl-3.0.html
10+
11+
Get your products in front of Pinterest users searching for ideas and things to buy. Connect your WooCommerce store to make your entire catalog browsable.
1212

1313
== Description ==
1414

15-
This is the long description. No limit, and you can use Markdown (as well as in the following sections).
15+
Pinterest gives people their next great idea. Part collection, part marketplace, it’s a one-stop shop for millions of pinners to source inspiration, new products and new possibilities. It’s like a visual search engine, guiding people to ideas, inspiration and products that are just right for them.
1616

17-
For backwards compatibility, if this section is missing, the full length of the short description will be used, and
18-
Markdown parsed.
17+
With the Pinterest for WooCommerce extension, you can put your products in front of Pinterest users who are already looking for ideas and things to buy. Connect your WooCommerce store to your *[Pinterest business account](https://business.pinterest.com/)* directly in the WooCommerce app. Your entire catalog will become browsable on Pinterest in just a few clicks.
1918

20-
A few notes about the sections above:
19+
= Open-minded and undecided =
2120

22-
* "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames
23-
* "Tags" is a comma separated list of tags that apply to the plugin
24-
* "Requires at least" is the lowest version that the plugin will work on
25-
* "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on
26-
higher versions... this is just the highest one you've verified.
27-
* Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for
28-
stable.
21+
People on Pinterest are eager for new ideas, which means they want to hear from you. In fact, 97% of top Pinterest searches are unbranded. Content from brands doesn’t interrupt on Pinterest—it inspires. Shopping features are built into both the organic Pinner experience, and our ad solutions.
2922

30-
Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so
31-
if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used
32-
for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt`
33-
is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in
34-
your in-development version, without having that information incorrectly disclosed about the current stable version
35-
that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.
23+
We'll also automatically set up your Pinterest tag, and a shop tab on your Pinterest profile.
3624

37-
If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where
38-
you put the stable version, in order to eliminate any doubt.
25+
*[Learn more about Shopping on Pinterest](https://business.pinterest.com/en/shopping/)*
3926

4027
== Installation ==
4128

42-
This section describes how to install the plugin and get it working.
29+
= Minimum Requirements =
4330

44-
e.g.
31+
* WordPress 5.6 or greater
32+
* WooCommerce 5.3 or greater
33+
* PHP version 7.3 or greater (PHP 7.4 or greater is recommended)
34+
* MySQL version 5.6 or greater
4535

46-
1. Upload `pinterest-for-woocommerce.php` to the `/wp-content/plugins/` directory
47-
1. Activate the plugin through the 'Plugins' menu in WordPress
48-
1. Place `<?php do_action('pinterest_for_woocommerce_hook'); ?>` in your templates
36+
Visit the [WooCommerce server requirements documentation](https://docs.woocommerce.com/document/server-requirements/) for a detailed list of server requirements.
4937

50-
== Frequently Asked Questions ==
38+
= Automatic installation =
5139

52-
= A question that someone might have =
40+
Automatic installation is the easiest option as WordPress handles the file transfers itself and you don’t need to leave your web browser. To do an automatic install of this plugin, log in to your WordPress dashboard, navigate to the Plugins menu and click Add New.
5341

54-
An answer to that question.
42+
In the search field type “Pinterest for WooCommerce” and click Search Plugins. Once you’ve found this plugin you can view details about it such as the point release, rating and description. Most importantly of course, you can install it by simply clicking “Install Now”.
5543

56-
= What about foo bar? =
44+
= Manual installation =
5745

58-
Answer to foo bar dilemma.
46+
The manual installation method involves downloading the plugin and uploading it to your webserver via your favourite FTP application. The WordPress codex contains [instructions on how to do this here](https://codex.wordpress.org/Managing_Plugins#Manual_Plugin_Installation).
5947

60-
== Screenshots ==
48+
= Where can I report bugs or contribute to the project? =
6149

62-
1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
63-
the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
64-
directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
65-
(or jpg, jpeg, gif).
66-
2. This is the second screen shot
50+
Bugs should be reported in the [Pinterest for WooCommerce repository](https://github.com/woocommerce/pinterest-for-woocommerce/).
6751

68-
== Changelog ==
69-
70-
= 1.0 =
71-
* A change since the previous version.
72-
* Another change.
73-
74-
= 0.5 =
75-
* List versions from most recent at top to oldest at bottom.
76-
77-
== Upgrade Notice ==
78-
79-
= 1.0 =
80-
Upgrade notices describe the reason a user should upgrade. No more than 300 characters.
81-
82-
= 0.5 =
83-
This version fixes a security related bug. Upgrade immediately.
84-
85-
== Arbitrary section ==
52+
= This is awesome! Can I contribute? =
8653

87-
You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated
88-
plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or
89-
"installation." Arbitrary sections will be shown below the built-in sections outlined above.
54+
Yes you can! Join in on our [GitHub repository](https://github.com/woocommerce/pinterest-for-woocommerce/) :)
9055

91-
== A brief Markdown Example ==
56+
Release and roadmap notes available on the [WooCommerce Developers Blog](hhttps://developer.woocommerce.com/)
9257

93-
Ordered list:
94-
95-
1. Some feature
96-
1. Another feature
97-
1. Something else about the plugin
98-
99-
Unordered list:
100-
101-
* something
102-
* something else
103-
* third thing
104-
105-
Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
106-
Titles are optional, naturally.
107-
108-
[markdown syntax]: http://daringfireball.net/projects/markdown/syntax
109-
"Markdown is what the parser uses to process much of the readme file"
110-
111-
Markdown uses email style notation for blockquotes and I've been told:
112-
> Asterisks for *emphasis*. Double it up for **strong**.
58+
== Changelog ==
11359

114-
`<?php code(); // goes in backticks ?>`
60+
= 1.0.0 - 2021-10-XX =
61+
- Initial release

0 commit comments

Comments
 (0)