Skip to content

Commit

Permalink
chore: merge pull request #6 from threeal/update-docs
Browse files Browse the repository at this point in the history
Update `README.md` and `package.json`
  • Loading branch information
threeal authored Jul 12, 2023
2 parents fe3ce8a + 3c7ed4b commit b5f4cd8
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,48 @@

[![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)

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.
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.

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.

## Installation

To install the `google-rank` tool globally, run the following command:

```
$ npm install --global google-rank
```

## Usage

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:

```
$ google-rank wikipedia.org krakatoa
Ranks for wikipedia.org website:
1 krakatoa
```

Multiple keywords can also be specified:

```
$ google-rank wikipedia.org krakatoa mit 'social media'
Ranks for wikipedia.org website:
1 krakatoa
2 mit
1 social media
```

If the website is not found for the specified keywords, it will output the rank as `?`:

```
$ google-rank wikipedia.org 'best city to travel'
Ranks for wikipedia.org website:
? best city to travel
```

## License

Expand Down
13 changes: 13 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
"name": "google-rank",
"version": "0.1.0",
"description": "Retrieve the Google search ranking of your website for specific keywords ",
"keywords": [
"cli",
"google",
"tools",
"seo",
"seotools",
"google-search",
"search-ranking"
],
"homepage": "https://github.com/threeal/google-rank",
"bugs": {
"url": "https://github.com/threeal/google-rank/issues",
Expand All @@ -15,6 +24,10 @@
"bin": {
"google-rank": "lib/google-rank.js"
},
"repository": {
"type": "git",
"url": "git+https://github.com/threeal/google-rank.git"
},
"scripts": {
"build": "dev build",
"clean": "dev clean",
Expand Down

0 comments on commit b5f4cd8

Please sign in to comment.