Skip to content

Commit b5f4cd8

Browse files
authored
chore: merge pull request #6 from threeal/update-docs
Update `README.md` and `package.json`
2 parents fe3ce8a + 3c7ed4b commit b5f4cd8

File tree

2 files changed

+55
-1
lines changed

2 files changed

+55
-1
lines changed

README.md

+42-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,48 @@
22

33
[![build status](https://img.shields.io/github/actions/workflow/status/threeal/google-rank/build.yaml?branch=main)](https://github.com/threeal/google-rank/actions/workflows/build.yaml)
44

5-
Google Rank is a tool that provides valuable insights into website visibility on [Google](https://www.google.com/) search results. Track and monitor your website's ranking for specific keywords to optimize online presence and reach a wider audience.
5+
Google Rank is a tool designed to provide valuable insights into website visibility on [Google](https://www.google.com/) search results. By tracking and monitoring your website's ranking for specific keywords, you can optimize your online presence and effectively reach a wider audience.
6+
7+
Whether you're an SEO specialist, a digital marketer, or a website owner, Google Rank empowers you to enhance your website's performance in search engine rankings. With this tool, you can stay informed about your website's visibility, make data-driven decisions, and improve your overall online presence.
8+
9+
## Installation
10+
11+
To install the `google-rank` tool globally, run the following command:
12+
13+
```
14+
$ npm install --global google-rank
15+
```
16+
17+
## Usage
18+
19+
To retrieve the rank of a website for a specific keyword, run the `google-rank` tool followed by the website URL and the search keyword:
20+
21+
```
22+
$ google-rank wikipedia.org krakatoa
23+
24+
Ranks for wikipedia.org website:
25+
1 krakatoa
26+
```
27+
28+
Multiple keywords can also be specified:
29+
30+
```
31+
$ google-rank wikipedia.org krakatoa mit 'social media'
32+
33+
Ranks for wikipedia.org website:
34+
1 krakatoa
35+
2 mit
36+
1 social media
37+
```
38+
39+
If the website is not found for the specified keywords, it will output the rank as `?`:
40+
41+
```
42+
$ google-rank wikipedia.org 'best city to travel'
43+
44+
Ranks for wikipedia.org website:
45+
? best city to travel
46+
```
647

748
## License
849

package.json

+13
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
"name": "google-rank",
33
"version": "0.1.0",
44
"description": "Retrieve the Google search ranking of your website for specific keywords ",
5+
"keywords": [
6+
"cli",
7+
"google",
8+
"tools",
9+
"seo",
10+
"seotools",
11+
"google-search",
12+
"search-ranking"
13+
],
514
"homepage": "https://github.com/threeal/google-rank",
615
"bugs": {
716
"url": "https://github.com/threeal/google-rank/issues",
@@ -15,6 +24,10 @@
1524
"bin": {
1625
"google-rank": "lib/google-rank.js"
1726
},
27+
"repository": {
28+
"type": "git",
29+
"url": "git+https://github.com/threeal/google-rank.git"
30+
},
1831
"scripts": {
1932
"build": "dev build",
2033
"clean": "dev clean",

0 commit comments

Comments
 (0)