Skip to content

Commit ea6bd93

Browse files
authored
Fix typos and enhance clarity in README.md
Corrected typos and improved clarity in README.
1 parent e0a3880 commit ea6bd93

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ Why use this plugin?
3131

3232

3333
### !TL;DidRead
34-
There are multiple ways to [verify](https://support.google.com/webmasters/answer/9008080?hl=en) the ownership of your site. The two simpler ways, both suitable for Github Pages owners, are to add an `<meta> tag to your pages` or upload a special unique file to the root of the site. For adding the meta tag, there are excellent plugins making this very easy for example [jekyll-seo-tag](http://jekyll.github.io/jekyll-seo-tag/usage/). If you want to the meta tag, I recommend this plugin.
34+
There are multiple ways to [verify](https://support.google.com/webmasters/answer/9008080?hl=en) the ownership of your site. The two simpler ways, both suitable for GitHub Pages owners, are to add a `<meta> tag to your pages` or upload a special, unique file to the root of the site. For adding the meta tag, there are excellent plugins making this very easy, for example [jekyll-seo-tag](http://jekyll.github.io/jekyll-seo-tag/usage/). If you want the meta tag, I recommend this plugin.
3535

36-
However if you feel that it's bloated to add this `<meta>` tag to the header all you pages, keeping file size and page load speed in mind, you may one to go for the file based verification method instead.
36+
However, if you feel that it's bloated to add this `<meta>` tag to the header of all your pages, keeping file size and page load speed in mind, you may one to go for the file-based verification method instead.
3737

38-
So with the file based method, why not just add the file you downloaded from GSC to your source directory and let Jekyll put it in `_site/` on generation? As we're using a SSG (Static Site Generator), we should generate everything we can. It's verdantly nice to keep the source tree clean and make everything that can be a configuration that generates what is needed.
38+
So with the file-based method, why not just add the file you downloaded from GSC to your source directory and let Jekyll put it in `_site/` on generation? As we're using an SSG (Static Site Generator), we should generate everything we can. It's very nice to keep the source tree clean and make everything that can be a configuration that generates what is needed.
3939

40-
Thus, this plugin exist to solve this problem. Give the plugin the unique code GSC provided you and it will generate the file for you in `_site/`!
40+
Thus, this plugin exists to solve this problem. Give the plugin the unique code GSC provided you, and it will generate the file for you in `_site/`!
4141

4242
Note that if you do place a verification file in the root of the source tree, this will override the generation by this plugin.
4343

@@ -60,27 +60,27 @@ Note that if you do place a verification file in the root of the source tree, th
6060
plugins:
6161
- jekyll-google_search_console_verification_file
6262
```
63-
1. Get the GSC unique code for you website.
63+
1. Get the GSC unique code for your website.
6464
1. Register your website at [Google Search Console](https://search.google.com/search-console?resource_id=https://erikw.me/)
6565
1. From the main dashboard of your site at GSC: _Settings > Ownership Verification > HTML File_ and download the unique file
66-
1. Instead of putting this file in our jekyll site, just copy the unique code from the HTML file name e.g. from `googlef47733b3288357e4.html` copy `f47733b3288357e4`.
66+
1. Instead of putting this file in our Jekyll site, just copy the unique code from the HTML file name, e.g., from `googlef47733b3288357e4.html`, copy `f47733b3288357e4`.
6767
1. In your site's `_config.yml`, configure this plugin with the code from the previous step:
6868
```yml
6969
google_search_console:
7070
verification_file_code: 47733b3288357e4
7171
```
72-
1. Now just build your site and verify that the verification file now exist!
72+
1. Now, just build your site and verify that the verification file now exists!
7373
```console
7474
$ bundle exec jekyll build
7575
$ ls _site/ | grep "google.*\.html"
7676
google47733b3288357e4.html
7777
```
7878

7979
# Development
80-
The structure of this plugin was inspired by [https://ayastreb.me/writing-a-jekyll-plugin/](https://ayastreb.me/writing-a-jekyll-plugin/), the plugin jekyll-sitemap and the [Bundler Gem tutorial](https://bundler.io/guides/creating_gem.html).
80+
The structure of this plugin was inspired by [https://ayastreb.me/writing-a-jekyll-plugin/](https://ayastreb.me/writing-a-jekyll-plugin/), the plugin jekyll-sitemap, and the [Bundler Gem tutorial](https://bundler.io/guides/creating_gem.html).
8181

8282
After checking out the repo;
83-
1. Install [RVM](https://rvm.io/rvm/install) and install a supported ruby version (see .gemspec)
83+
1. Install [RVM](https://rvm.io/rvm/install) and install a supported Ruby version (see .gemspec)
8484
1. run `scripts/setup` to install dependencies
8585
1. run `scripts/test` to run the tests
8686
1. You can also run `scripts/console` for an interactive prompt that will allow you to experiment.
@@ -89,7 +89,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
8989

9090

9191
## Local development
92-
Following the setup at [how-to-specify-local-ruby-gems-in-your-gemfile](https://rossta.net/blog/how-to-specify-local-ruby-gems-in-your-gemfile.html), these are the steps needed to build a jekyll site with a local clone of this plugin for local testing.
92+
Following the setup at [how-to-specify-local-ruby-gems-in-your-gemfile](https://rossta.net/blog/how-to-specify-local-ruby-gems-in-your-gemfile.html), these are the steps needed to build a Jekyll site with a local clone of this plugin for local testing.
9393

9494
1. Clone this repo to your machine, say at `~/src/jekyll-google_search_console_verification_file`
9595
1. In your Jekyll project's `Gemfile`:
@@ -98,13 +98,13 @@ Following the setup at [how-to-specify-local-ruby-gems-in-your-gemfile](https://
9898
1. Configure bundler to use a local path for this gem in this project:
9999
- `$ bundle config --local local.jekyll-google_search_console_verification_file ~/src/jekyll-google_search_console_verification_file`
100100
1. Update the project: `$ bundle install`
101-
1. Now the project will build with the local clone of this plugin when issuing e.g. `bundle exec jekyll build`
101+
1. Now the project will build with the local clone of this plugin when issuing e.g., `bundle exec jekyll build`
102102
1. When you're done:
103103
- Remove the local override with: `$ bundle config --delete local.jekyll-google_search_console_verification_file`
104-
- Optionally restore the original gem include in `Gemfile` or keep building from a branch in the github repo.
104+
- Optionally restore the original gem included in `Gemfile` or keep building from a branch in the GitHub repo.
105105

106106
## Releasing
107-
Instructions for releasing on rubygems.org below. Optionally make a GitHub [release](https://github.com/erikw/jekyll-google_search_console_verification_file/releases) after this for the pushed git tag.
107+
Instructions for releasing on rubygems.org are below. Optionally make a GitHub [release](https://github.com/erikw/jekyll-google_search_console_verification_file/releases) after this for the pushed git tag.
108108

109109
## [manual] Using bundler/gem_tasks rake tasks
110110
Following instructions from [bundler.io](https://bundler.io/guides/creating_gem.html#releasing-the-gem):
@@ -129,7 +129,7 @@ gem bump --version minor --tag --push --release --sign
129129
For `--version`, use `major|minor|patch` as needed.
130130

131131
## Multi-versions
132-
* For ruby, just use RVM to switch between supported ruby version specified in `.gemspec`.
132+
* For Ruby, just use RVM to switch between supported Ruby versions specified in `.gemspec`.
133133
* To run with different jekyll versions, [Appraisal](https://github.com/thoughtbot/appraisal) is used with [`Appraisals`](Appraisals) to generate different [`gemfiles/`](gemfiles/)
134134
- To use a specific Gemfile, run like
135135
```shell
@@ -156,7 +156,7 @@ To use the [travis cli client](https://github.com/travis-ci/travis.rb) (installe
156156
```shell
157157
bundle exec travis endpoint --set-default --api-endpoint https://api.travis-ci.com/
158158
```
159-
1. Login with the cli client
159+
1. Log in with the CLI client
160160
```shell
161161
bundle exec travis login --github-token $GITHUB_TOKEN
162162
```

0 commit comments

Comments
 (0)