← All changes | README.md +64 -48 3.2.0 → 3.8.4 View file →

		@@ -1,14 +1,14 @@
1	1	# Parse.ly
2	2
3		-Stable tag: 3.2.0
	3	+Stable tag: 3.8.4
4	4	Requires at least: 5.0
5		-Tested up to: 5.9.2
6		-Requires PHP: 7.1
	5	+Tested up to: 6.1
	6	+Requires PHP: 7.2
7	7	License: GPLv2 or later
8	8	License URI: https://www.gnu.org/licenses/gpl-2.0.html
9	9	Tags: analytics, content marketing, parse.ly, parsely, parsley
10		-Contributors: parsely, hbbtstar, jblz, mikeyarce, GaryJ, parsely_mike, pauargelaguet, acicovic
	10	+Contributors: parsely, hbbtstar, jblz, mikeyarce, GaryJ, parsely_mike, acicovic, mehmoodak
11	11
12	12	The Parse.ly plugin facilitates real-time and historical analytics to your content through a platform designed and built for digital publishing.
13	13
14	14	## Description
		@@ -16,54 +16,56 @@
16	16	Designed and built for digital publishers, Parse.ly helps you understand how your audience is connecting to your content.
17	17
18	18	Thousands of writers, editors, site managers, and technologists already use Parse.ly to understand what content draws in website visitors, and why. Using our powerful dashboards and APIs, customers build successful digital strategies that allow them to grow and engage a loyal audience.
19	19
20		-Join industry leaders -- like Mashable, Slate, News Corp, and Conde Nast -- who already use Parse.ly to bring clarity to content, audience, and analytics.
	20	+Join industry leaders -- like NBA, Slate, News Corp, and Conde Nast -- who already use Parse.ly to bring clarity to content, audience, and analytics.
21	21
22		-### Features
	22	+Feedback, suggestions, questions or concerns? Open a new [GitHub issue](https://github.com/Parsely/wp-parsely/issues) or email us at [support@parsely.com](mailto:support@parsely.com). We always want to hear from you!
23	23
24		-- Get started with Parse.ly right away: the plugin automatically inserts the required metadata and JavaScript on all your published pages and posts.
25		-- Choose what format the metadata takes, and whether logged-in users should be included in the analytics.
26		-- Using it in a decoupled setup? Parse.ly adds metadata to the REST API output for pages, posts and optionally other object types.
27		-- If you've purchased access to the Parse.ly API, add a widget to your site with article recommendations personalized to individual users.
	24	+**NOTE:** The plugin requires an active Parse.ly account. [Sign up for a free Parse.ly demo](https://www.parsely.com/getdemo?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely).
28	25
29		-Feedback, suggestions, questions or concerns? Open a new [GitHub issue](https://github.com/Parsely/wp-parsely/issues) or email us at [support@parsely.com](mailto:support@parsely.com). We always want to hear from you!
	26	+### Features
30	27
31		-### Documentation
	28	+The wp-parsely plugin is packed with features that allow for a seamless integration process, and brings the power of the Parse.ly dashboard into WordPress.
32	29
33		-If you are looking for the plugin's documentation and how to set up your WordPress site with Parse.ly, take a look at [the Parse.ly integration docs](https://www.parsely.com/help/integration/wordpress).
	30	+#### Automated integration
34	31
35		-In case you are a WordPress VIP customer, [VIP's documentation](https://docs.wpvip.com/technical-references/plugins/parse-ly/) will be also useful for you.
	32	+The plugin automatically inserts the Parse.ly metadata and JavaScript in all published pages and posts (Custom Post Types are supported). It also provides a settings page to customize your integration, with options including:
	33	+- Output Parse.ly metadata as [JSON-LD](https://docs.parse.ly/metadata-jsonld/) or [repeated meta tags](https://docs.parse.ly/metatags/).
	34	+- Choose whether logged-in users should be tracked.
	35	+- Define how to track every Post Type (as Post, Non-Post or no tracking).
36	36
37		-## Installation
	37	+#### The Parse.ly Content Helper
38	38
39		-The plugin requires an active Parse.ly account. [Sign up for a free demo of Parse.ly](https://www.parsely.com/getdemo?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely).
	39	+The [Content Helper](https://docs.parse.ly/plugin-content-helper/) is a set of content insight tools including:
	40	+- The [Parse.ly Dashboard Widget](https://docs.parse.ly/plugin-content-helper/#h-dashboard) - Displays the site's top posts in the last 7 days in the WordPress Dashboard.
	41	+- The [Parse.ly Stats Column](https://docs.parse.ly/plugin-content-helper/#h-posts) - Displays published post performance for the last 7 days in Post Lists.
	42	+- The [Parse.ly Editor Sidebar](https://docs.parse.ly/plugin-content-helper/#h-editor) - This sidebar is integrated into the WordPress Editor and offers insights about the content currently being edited such as:
	43	+ - [Performance Details](https://docs.parse.ly/plugin-content-helper/#h-performance-details) - Displays performance metrics about the content currently being edited.
	44	+ - [Related Top Posts](https://docs.parse.ly/plugin-content-helper/#h-related-top-posts) - Displays a list of the website’s most successful posts, similar to the post/page currently being edited.
40	45
41		-### Install the plugin from within WordPress
	46	+#### The Parse.ly Recommendations Block
42	47
43		-1. Visit the Plugins page from your WordPress dashboard and click "Add New" at the top of the page.
44		-2. Search for _parse.ly_ using the search bar on the right side.
45		-3. Click _Install Now_ to install the plugin.
46		-4. After it's installed, click _Activate_ to activate the plugin on your site.
	48	+The plugin includes a [Recommendations Block](https://docs.parse.ly/recommendations-block/) that displays a list of posts related to the currently viewed post/page. The Block is useful for showcasing related content to visitors, and it can also be used in Full Site Editing mode or as a [Block-based Widget](https://wordpress.org/documentation/article/block-based-widgets-editor/).
47	49
48		-### Install the plugin manually
	50	+#### Advanced integrations support
49	51
50		-1. Download the plugin from [WordPress.org](https://wordpress.org/plugins/wp-parsely/) or get the latest release from our [Github Releases page](https://github.com/Parsely/wp-parsely/releases).
51		-2. Unzip the downloaded archive.
52		-3. Upload the entire `wp-parsely` folder to your `/wp-content/plugins` directory.
53		-4. Visit the Plugins page from your WordPress dashboard and look for the newly installed Parse.ly plugin.
54		-5. Click _Activate_ to activate the plugin on your site.
	52	+While the plugin works out of the box for basic integrations, it offers a host of features that easily allow for advanced integration scenarios:
	53	+- Support for [Google Tag Manager, AMP, Facebook Instant Articles, Google Web Stories and Cloudflare](https://docs.parse.ly/plugin-common-questions/#h-is-wp-parsely-compatible-with-amp-facebook-instant-articles-or-google-web-stories) is included.
	54	+- The plugin exposes the `wpParselyOnLoad` and `wpParselyOnReady` JavaScript hooks that allow for advanced integrations requiring JavaScript, such as [Dynamic Tracking](https://docs.parse.ly/plugin-dynamic-tracking/).
	55	+- Support for WordPress [network/multisite](https://docs.parse.ly/plugin-common-questions/#h-is-wp-parsely-compatible-with-wordpress-network-multisite) and [decoupled/headless](https://docs.parse.ly/plugin-decoupled-headless-support/) (GraphQL and WP Rest API) setups is included.
	56	+- Last but not least, a wide range of hooks is available in order to customize the plugin's functionality even further.
55	57
56		-Note that this method is the recommended one for installing old versions of the plugin. Those can be downloaded from [WordPress.org](https://wordpress.org/plugins/wp-parsely/advanced/) or the GitHub Releases page.
	58	+### Documentation and resources
57	59
58		-## Local development
	60	+- [Plugin Documentation](https://docs.parse.ly/wordpress-plugin-setup/).
	61	+- [Commonly Asked Questions](https://docs.parse.ly/plugin-common-questions/).
	62	+- [Changelog](https://github.com/parsely/wp-parsely/blob/trunk/CHANGELOG.md).
59	63
60		-Development, code hosting and issue tracking of this plugin happens on the [wp-parsely GitHub repository](https://github.com/Parsely/wp-parsely/). Active development happens on the `develop` branch and releases are made off the `trunk` branch.
	64	+**IMPORTANT:** If you are a [WordPress VIP](https://wpvip.com/) customer, the plugin should be enabled by using an `mu-plugins` filter. Please consult the [WordPress VIP documentation](https://docs.wpvip.com/technical-references/plugins/parse-ly/) for more details.
61	65
62		-To run the plugin locally or to contribute to it, please check the instructions in the [CONTRIBUTING](https://github.com/parsely/wp-parsely/blob/trunk/CONTRIBUTING.md) file.
	66	+### Sample Parse.ly metadata
63	67
64		-## Sample Parse.ly metadata
65		-
66	68	The standard Parse.ly JavaScript tracker inserted before the closing `body` tag:
67	69
68	70	~~~html
69	71	<script id="parsely-cfg" data-parsely-site="example.com" src="https://cdn.parsely.com/keys/example.com/p.js"></script>
		@@ -84,28 +86,42 @@
84	86	{"@context":"http:\/\/schema.org","@type":"NewsArticle","mainEntityOfPage":{"@type":"WebPage","@id":"http:\/\/wpvip.com\/2021\/04\/09\/how-the-wordpress-gutenberg-block-editor-empowers-enterprise-content-creators\/"},"headline":"How the WordPress Gutenberg Block Editor Empowers Enterprise Content Creators","url":"http:\/\/wpvip.com\/2021\/04\/09\/how-the-wordpress-gutenberg-block-editor-empowers-enterprise-content-creators\/","thumbnailUrl":"https:\/\/wpvip.com\/wp-content\/uploads\/2021\/04\/ladyatdesk.png?w=120","image":{"@type":"ImageObject","url":"https:\/\/wpvip.com\/wp-content\/uploads\/2021\/04\/ladyatdesk.png?w=120"},"dateCreated":"2021-04-09T15:13:13Z","datePublished":"2021-04-09T15:13:13Z","dateModified":"2021-04-09T15:13:13Z","articleSection":"Gutenberg","author":[{"@type":"Person","name":"Sam Wendland"}],"creator":["Sam Wendland"],"publisher":{"@type":"Organization","name":"The Enterprise Content Management Platform | WordPress VIP","logo":"https:\/\/wpvip.com\/wp-content\/uploads\/2020\/11\/cropped-favicon-dark.png"},"keywords":[]}
85	87	</script>
86	88	~~~
87	89
88		-## The Parse.ly Recommendations Block (beta)
	90	+### Contributing
89	91
90		-The plugin includes a Recommendations Block that uses the [Parse.ly API](https://www.parse.ly/help/api/recommendations#get-related) to showcase links to content on your site. More information about enabling the Recommendations Block can be found in its [documentation](https://github.com/Parsely/wp-parsely/blob/trunk/src/blocks/recommendations/README.md). This feature is currently in beta and disabled by default.
	92	+Development, code hosting and issue tracking of this plugin happens on the [wp-parsely GitHub repository](https://github.com/Parsely/wp-parsely/). Active development happens on the `develop` branch and releases are made off the `trunk` branch.
91	93
92		-## Screenshots
	94	+To run the plugin locally or to contribute to it, please check the instructions in the [CONTRIBUTING](https://github.com/parsely/wp-parsely/blob/trunk/CONTRIBUTING.md) file.
93	95
94		-1. Parse.ly plugin main settings for easy setup. For the plugin to start working, only the website ID is needed.
95		- 
96		-2. Parse.ly plugin settings that require you to submit a website recrawl request whenever you update them.
97		- 
98		-3. Parse.ly plugin advanced settings. To be used only if instructed by Parse.ly staff.
99		- 
100		-4. The settings for the Parse.ly Recommended Widget. Engage your visitors with predictive and personalized recommendations from Parse.ly.
101		- 
102		-5. A view of the Parse.ly Dashboard Overview. Parse.ly offers analytics that empowers you to better understand how your content is peforming.
103		- 
	96	+## Installation
104	97
	98	+The plugin requires an active Parse.ly account. [Sign up for a free demo of Parse.ly](https://www.parsely.com/getdemo?utm_medium=referral&utm_source=wordpress.org&utm_content=wp-parsely).
	99	+
	100	+For more information, please visit the [installation instructions](https://docs.parse.ly/wordpress-plugin-setup/) in the official documentation.
	101	+
105	102	## Frequently Asked Questions
106	103
107		-See [frequently asked questions](https://www.parse.ly/help/integration/wordpress#frequently-asked-questions) on the Parse.ly Technical Documentation.
	104	+Please visit the [Commonly Asked Questions page](https://docs.parse.ly/plugin-common-questions/) in the official documentation.
108	105
109	106	## Changelog
110	107
111		-See the [change log](https://github.com/parsely/wp-parsely/blob/trunk/CHANGELOG.md).
	108	+Please visit the [changelog](https://github.com/parsely/wp-parsely/blob/trunk/CHANGELOG.md).
	109	+
	110	+## Screenshots
	111	+
	112	+1. Parse.ly plugin basic settings for easy setup. For the plugin to start working, only the Site ID is needed.
	113	+ 
	114	+2. Parse.ly plugin settings that require a website recrawl whenever they are updated.
	115	+ 
	116	+3. Parse.ly plugin advanced settings, to be used only if instructed by Parse.ly staff.
	117	+ 
	118	+4. The Parse.ly Dashboard Widget, showing the website's top posts in the last 7 days.
	119	+ 
	120	+5. The Parse.ly Stats Column (on the right), showing information about content that is being tracked as Posts.
	121	+ 
	122	+6. The Parse.ly Editor Sidebar, featuring the Performance Details and Related Top Posts panels.
	123	+ 
	124	+7. The Recommendations Block, showcasing links to related content on your site.
	125	+ 
	126	+8. A view of the Parse.ly Dashboard Overview. Parse.ly offers analytics that empower you to better understand how your content is performing.
	127	+