Skip to content

Commit 6d0fcda

Browse files
committed
Readmes.
1 parent fab8b7a commit 6d0fcda

File tree

2 files changed

+126
-1
lines changed

2 files changed

+126
-1
lines changed

readme.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,76 @@
11
# Simple Search Submission for IndexNow
22

3+
A simplified plugin for submitting crawl requests to search engines supporting IndexNow.
4+
5+
## Description
6+
7+
[IndexNow](https://www.indexnow.org/) is a simple way of notifying search engines of updates to URLs on a site.
8+
9+
IndexNow allows website owners to submit a request to search engines to prioritize the crawling of a particular page or blog post on your site.
10+
11+
This plugin provides a no-fuss, simple alternative to just submit updates to the search engines.
12+
13+
Crawl requests will be sent to search engines when:
14+
15+
* new content is published
16+
* existing content is updated
17+
* existing content is unpublished (this encourages de-indexing)
18+
19+
The biggest features of this plugin are the features that it's missing:
20+
21+
* there are no settings, it just works
22+
* there are no onboarding steps, it just works
23+
* there are no custom database tables, it just works
24+
* simply put, there is no fuss!
25+
26+
Simple Search Submission for IndexNow submits the update requests as you save your content. If you wish to submit the URLs
27+
asynchronously via a cron job, you can include the code `add_filter( 'simple_search_submission_notify_async', '__return_true' );`
28+
in your theme or or plugin.
29+
30+
## Installation
31+
32+
Simple Search Submission for IndexNow can be installed via the following methods
33+
34+
*Composer*
35+
36+
```
37+
composer require peterwilsoncc/simple-search-submission
38+
```
39+
40+
*Downloads*
41+
42+
* Via WordPress.org (Pending)
43+
* [Via GitHub](https://github.com/peterwilsoncc/simple-search-submission/releases/latest)
44+
45+
## Frequently Asked Questions
46+
47+
### Where is the settings page?
48+
49+
There is no settings page for this plugin, simply activate the plugin and it will work as intended.
50+
51+
### Is this needed if I run an SEO plugin? (Spoiler: possibly)
52+
53+
Possibly.
54+
55+
Most SEO Plugins only include IndexNow support in their paid versions of the plugin. If you are using a free SEO plugin (such as Yoast SEO or All In One SEO), it is likely you will need this plugin to speed up indexing of your site's new content.
56+
57+
If your SEO plugin does support IndexNow then you should not install this plugin. Doing so will double up requests to search engines to index your content. For large sites publishing regularly, this will increase the chance you reach your maximum number of URL submissions.
58+
59+
### Is this needed if I run Bing's IndexNow plugin?
60+
61+
No, but it's more complicated than that.
62+
63+
This plugin is intended as a replacement for the Bing plugin that is much simplified and just works.
64+
65+
### Why does this submit requests when content is unpublished?
66+
67+
IndexNow supports both notifications for newly published content and newly unpublished content.
68+
69+
When unpublishing content, the notification serves as a request to de-index the newly 404 response on your site.
70+
Sending a de-indexing request ensures that your site's old content does not appear in indexes and result in a file not found error.
71+
72+
## Changelog
73+
74+
### 1.0.0
75+
76+
* Initial release

readme.txt

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,62 @@ Stable tag: 1.0.0
66
License: GPL-2.0-or-later
77
License URI: https://github.com/peterwilsoncc/simple-search-submission/blob/main/LICENSE
88

9-
Short Description
9+
A simplified plugin for submitting crawl requests to search engines supporting IndexNow.
1010

1111
== Description ==
1212

13+
[IndexNow](https://www.indexnow.org/) is a simple way of notifying search engines of updates to URLs on a site.
14+
15+
IndexNow allows website owners to submit a request to search engines to prioritize the crawling of a particular page or blog post on your site.
16+
17+
This plugin provides a no-fuss, simple alternative to just submit updates to the search engines.
18+
19+
Crawl requests will be sent to search engines when:
20+
21+
* new content is published
22+
* existing content is updated
23+
* existing content is unpublished (this encourages de-indexing)
24+
25+
The biggest features of this plugin are the features that it's missing:
26+
27+
* there are no settings, it just works
28+
* there are no onboarding steps, it just works
29+
* there are no custom database tables, it just works
30+
* simply put, there is no fuss!
31+
32+
Simple Search Submission for IndexNow submits the update requests as you save your content. If you wish to submit the URLs
33+
asynchronously via a cron job, you can include the code `add_filter( 'simple_search_submission_notify_async', '__return_true' );`
34+
in your theme or or plugin.
1335

1436
== Frequently Asked Questions ==
1537

38+
= Where is the settings page? =
39+
40+
There is no settings page for this plugin, simply activate the plugin and it will work as intended.
41+
42+
= Is this needed if I run an SEO plugin? (Spoiler: possibly) =
43+
44+
Possibly.
45+
46+
Most SEO Plugins only include IndexNow support in their paid versions of the plugin. If you are using a free SEO plugin (such as Yoast SEO or All In One SEO), it is likely you will need this plugin to speed up indexing of your site's new content.
47+
48+
If your SEO plugin does support IndexNow then you should not install this plugin. Doing so will double up requests to search engines to index your content. For large sites publishing regularly, this will increase the chance you reach your maximum number of URL submissions.
49+
50+
= Is this needed if I run Bing's IndexNow plugin? =
51+
52+
No, but it's more complicated than that.
53+
54+
This plugin is intended as a replacement for the Bing plugin that is much simplified and just works.
55+
56+
= Why does this submit requests when content is unpublished? =
57+
58+
IndexNow supports both notifications for newly published content and newly unpublished content.
59+
60+
When unpublishing content, the notification serves as a request to de-index the newly 404 response on your site.
61+
Sending a de-indexing request ensures that your site's old content does not appear in indexes and result in a file not found error.
62+
1663
== Changelog ==
64+
65+
= 1.0.0 =
66+
67+
* Initial release

0 commit comments

Comments
 (0)