Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
3Alan committed Oct 14, 2022
1 parent e36b390 commit b6ecc9b
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 548,008 deletions.
42 changes: 36 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,47 @@
# search-engines-urls-push

Use this Github Action to push your site urls to search engines(Google, Bing, Baidu)

## Supported Search Engines

- Google
- Bing
- Baidu

## Actions secrets
## Example usage

```yml
uses: 3Alan/[email protected]
with:
site: ${{ secrets.SITE }}
sitemap: ${{ secrets.SITEMAP }}
count: ${{ secrets.COUNT }}
bing-token: ${{ secrets.BING_TOKEN }}
baidu-token: ${{ secrets.BAIDU_TOKEN }}
google-client-email: ${{ secrets.GOOGLE_CLIENT_EMAIL }}
google-private-key: ${{ secrets.GOOGLE_PRIVATE_KEY }}
```
## Action inputs
| Name | Description | Required |
| ------------------- | ------------------------------------------------------------------------------------------------------ | -------- |
| site | your site url | true |
| sitemap | your sitemap url | true |
| count | the numbers of urls pushed to search engines, if empty, all your urls will be pushed | false |
| google-client-email | client_email, [how to get it](https://github.com/3Alan/search-engines-urls-push-action#google-secrets) | false |
| google-private-key | private_key, [how to get it](https://github.com/3Alan/search-engines-urls-push-action#google-secrets) | false |
| bing-token | Bing API Key, [how to get it](https://github.com/3Alan/search-engines-urls-push-action#bing-token) | false |
| baidu-token | [how to get it](https://github.com/3Alan/search-engines-urls-push-action#baidu-token) | false |
## Google secrets
Follow the [tutorial](https://developers.google.com/search/apis/indexing-api/v3/prereqs), you will a json file containing the `private_key` and `client_email`

## Bing token
## Baidu token

## Example usage
[Bing webmasters tool](https://www.bing.com/webmasters), You can get `API Key` from the settings/API access/API Key

uses: actions/[email protected]
with:
who-to-greet: 'Mona the Octocat'
## Baidu token

You can find it on this [website](https://ziyuan.baidu.com/linksubmit/index)
9 changes: 5 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
name: 'search-engines-urls-push'
author: 3Alan
description: 'push your urls to search engines, support google,bing,baidu'
color: 'blue'
branding:
icon: 'upload-cloud'
color: 'blue'
inputs:
site: # id of input
site: # id of input
description: 'your site url'
required: true
sitemap:
description: 'your sitemap url'
required: true
count:
description: 'push urls count'
count: 10
baidu-token:
description: 'baidu token'
bing-token:
Expand All @@ -22,4 +23,4 @@ inputs:
description: 'google private key'
runs:
using: 'node16'
main: 'index.js'
main: 'index.js'
Loading

0 comments on commit b6ecc9b

Please sign in to comment.