meta-tags 2.19.0 → 2.20.0

data/README.md

@@ -1,6 +1,6 @@
 # MetaTags: a gem to make your Rails application SEO-friendly
 
-[![CircleCI](https://circleci.com/gh/kpumuk/meta-tags.svg?style=shield)](https://circleci.com/gh/kpumuk/meta-tags)
+[![Tests](https://github.com/kpumuk/meta-tags/actions/workflows/tests.yml/badge.svg)](https://github.com/kpumuk/meta-tags/actions/workflows/tests.yml)
 [![Gem Version](https://badge.fury.io/rb/meta-tags.svg)](https://badge.fury.io/rb/meta-tags)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![Code Climate](https://codeclimate.com/github/kpumuk/meta-tags/badges/gpa.svg)](https://codeclimate.com/github/kpumuk/meta-tags)
@@ -12,13 +12,10 @@ Search Engine Optimization (SEO) plugin for Ruby on Rails applications.
 
 ## Ruby on Rails
 
-MetaTags main branch fully supports Ruby on Rails 5.1+, and is tested against all
-major Rails releases up to 7.1.
+The MetaTags main branch fully supports Ruby on Rails 6.0+ and is tested against all major Ruby on Rails releases.
 
-Ruby versions older than 2.7 are no longer officially supported.
-
-_Please note_ that we no longer support Ruby versions older than 2.6.0 and
-Ruby on Rails older than 5.1, because they reached their [End of Life](https://endoflife.date/ruby).
+> [!NOTE]
+> We no longer support Ruby versions older than 2.7 and Ruby on Rails older than 6.0 since they reached their end of life (see [Ruby](https://endoflife.date/ruby) and [Ruby on Rails](https://endoflife.date/rails)).
 
 ## Installation
 
@@ -32,23 +29,15 @@ And run `bundle install` command.
 
 ## Configuration
 
-MetaTags follows best-practices for meta tags. Although default limits for
-truncation have recommended values, you can change them to reflect your own
-preferences. Keywords are converted to lowercase by default, but this is also
-configurable.
+MetaTags follows best practices for meta tags. Although default limits for truncation have recommended values, you can change them to reflect your own preferences. Keywords are converted to lowercase by default, but this is also configurable.
 
-To override the defaults, create an initializer
-`config/initializers/meta_tags.rb` using the following command:
+To override the defaults, create an initializer `config/initializers/meta_tags.rb` using the following command:
 
 ```bash
 rails generate meta_tags:install
 ```
 
-By default meta tags are rendered with the key `name`. Since, some meta tags are
-required to use `property` instead (like Facebook Open Graph object), MetaTags gem
-allows to configure which tags to render with `property` attribute. By default
-the pre-configured list includes all possible Facebook Open Graph object types, but
-you can add your own in case you need it.
+By default, meta tags are rendered with the key `name`. However, some meta tags are required to use `property` instead (like Facebook Open Graph object). The MetaTags gem allows you to configure which tags to render with the `property` attribute. The pre-configured list includes all possible Facebook Open Graph object types by default, but you can add your own in case you need it.
 
 ## MetaTags Usage
 
@@ -77,11 +66,14 @@ When views are rendered, the page title will be included in the right spots:
 </body>
 ```
 
-You can find allowed options for `display_meta_tags` method below.
+You can find allowed options for the `display_meta_tags` method below.
+
+> [!IMPORTANT]
+> You **must** use `display_meta_tags` in the layout files to render the meta tags. In the views, you will instead use `set_meta_tags`, which accepts the same arguments but does not render anything in the place where it is called.
 
 ### Using MetaTags in controller
 
-You can define following instance variables:
+You can define the following instance variables:
 
 ```ruby
 @page_title = "Member Login"
@@ -89,7 +81,7 @@ You can define following instance variables:
 @page_keywords = "Site, Login, Members"
 ```
 
-Also you could use `set_meta_tags` method to define all meta tags simultaneously:
+Also, you could use the `set_meta_tags` method to define all meta tags simultaneously:
 
 ```ruby
 set_meta_tags(
@@ -99,11 +91,11 @@ set_meta_tags(
 )
 ```
 
-You can find allowed options for `set_meta_tags` method below.
+You can find the allowed options for the `set_meta_tags` method below.
 
 ### Using MetaTags in view
 
-To set meta tags you can use following methods:
+To set meta tags, you can use the following methods:
 
 ```erb
 <% title "Member Login" %>
@@ -114,7 +106,7 @@ To set meta tags you can use following methods:
 <% refresh 3 %>
 ```
 
-Also there is `set_meta_tags` method exists:
+Also, the `set_meta_tags` method exists:
 
 ```erb
 <%
@@ -126,7 +118,7 @@ Also there is `set_meta_tags` method exists:
 %>
 ```
 
-You can pass an object that implements `#to_meta_tags` method and returns a Hash:
+You can pass an object that implements the `#to_meta_tags` method and returns a Hash:
 
 ```ruby
 class Document < ApplicationRecord
@@ -142,7 +134,7 @@ end
 set_meta_tags @document
 ```
 
-The `title` method returns title itself, so you can use it to show the title
+The `title` method returns the title itself, so you can use it to show the title
 somewhere on the page:
 
 ```erb
@@ -159,30 +151,30 @@ If you want to set the title and display another text, use this:
 
 Use these options to customize the title format:
 
-| Option         | Description                                                                                                          |
-| -------------- | -------------------------------------------------------------------------------------------------------------------- |
-| `:site`        | site title                                                                                                           |
-| `:title`       | page title                                                                                                           |
-| `:description` | page description                                                                                                     |
-| `:keywords`    | page keywords                                                                                                        |
-| `:charset`     | page character set                                                                                                   |
-| `:prefix`      | text between site name and separator                                                                                 |
-| `:separator`   | text used to separate website name from page title                                                                   |
-| `:suffix`      | text between separator and page title                                                                                |
-| `:lowercase`   | when true, the page name will be lowercase                                                                           |
-| `:reverse`     | when true, the page and site names will be reversed                                                                  |
-| `:noindex`     | add noindex meta tag; when true, "robots" will be used; accepts a string with a robot name, or an array of strings   |
-| `:index`       | add index meta tag; when true, "robots" will be used; accepts a string with a robot name, or an array of strings     |
-| `:nofollow`    | add nofollow meta tag; when true, "robots" will be used; accepts a string with a robot name, or an array of strings  |
-| `:follow`      | add follow meta tag; when true, "robots" will be used; accepts a string with a robot name, or an array of strings    |
-| `:noarchive`   | add noarchive meta tag; when true, "robots" will be used; accepts a string with a robot name, or an array of strings |
-| `:canonical`   | add canonical link tag                                                                                               |
-| `:prev`        | add prev link tag                                                                                                    |
-| `:next`        | add next link tag                                                                                                    |
-| `:image_src`   | add image_src link tag                                                                                               |
-| `:og`          | add Open Graph tags (Hash)                                                                                           |
-| `:twitter`     | add Twitter tags (Hash)                                                                                              |
-| `:refresh`     | refresh interval and optionally url to redirect to                                                                   |
+| Option         | Description                                                                                                         |
+| -------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `:site`        | Site title                                                                                                          |
+| `:title`       | Page title                                                                                                          |
+| `:description` | Page description                                                                                                    |
+| `:keywords`    | Page keywords                                                                                                       |
+| `:charset`     | Page character set                                                                                                  |
+| `:prefix`      | Text between site name and separator                                                                                |
+| `:separator`   | Text used to separate the website name from the page title                                                          |
+| `:suffix`      | Text between separator and page title                                                                               |
+| `:lowercase`   | When true, the page name will be lowercase                                                                          |
+| `:reverse`     | When true, the page and site names will be reversed                                                                 |
+| `:noindex`     | Add noindex meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings   |
+| `:index`       | Add index meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings     |
+| `:nofollow`    | Add nofollow meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings  |
+| `:follow`      | Add follow meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings    |
+| `:noarchive`   | Add noarchive meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings |
+| `:canonical`   | Add canonical link tag                                                                                              |
+| `:prev`        | Add prev link tag                                                                                                   |
+| `:next`        | Add next link tag                                                                                                   |
+| `:image_src`   | Add image_src link tag                                                                                              |
+| `:og`          | Add Open Graph tags (Hash)                                                                                          |
+| `:twitter`     | Add Twitter tags (Hash)                                                                                             |
+| `:refresh`     | Refresh interval and optionally URL to redirect to                                                                  |
 
 And here are a few examples to give you ideas.
 
@@ -206,22 +198,20 @@ set_meta_tags title: ["part1", "part2"], reverse: true, site: "site"
 # part2 | part1 | site
 ```
 
-Keywords can be passed as string of comma-separated values, or as an array:
+Keywords can be passed as a string of comma-separated values or as an array:
 
 ```ruby
 set_meta_tags keywords: ["tag1", "tag2"]
 # tag1, tag2
 ```
 
-Description is a string (HTML will be stripped from output string).
+The description is a string (HTML will be stripped from the output string).
 
 ### Mirrored values
 
-Sometimes, it is desirable to mirror meta tag values down into namespaces. A
-common use case is when you want open graph's `og:title` to be identical to
-the `title`.
+Sometimes, it is desirable to mirror meta tag values down into namespaces. A common use case is when you want the open graph's `og:title` to be identical to the `title`.
 
-Say, you have the following in your application layout:
+Let's say you have the following code in your application layout:
 
 ```ruby
 display_meta_tags og: {
@@ -230,40 +220,48 @@ display_meta_tags og: {
 }
 ```
 
-The value of `og[:title]` is a symbol and therefore references the value of the
-top level `title` meta tag. With the following in any view:
+The value of `og[:title]` is a symbol, which refers to the value of the top-level `title` meta tag. In any view with the following code:
 
 ```ruby
 title "my great view"
 ```
 
-You get this open graph meta tag for free:
+You will get this open graph meta tag automatically:
 
 ```html
 <meta property="og:title" content="my great view"></meta>
 ```
 
-Please note, that title does not include site. If you need to reference the exact
-value rendered in the `<title>` meta tag, use `:full_title`.
+> [!NOTE]
+> The `title` does not include the site name. If you need to reference the exact value rendered in the `<title>` meta tag, use `:full_title`.
+
+### Using with Turbo
+
+[Turbo](https://github.com/hotwired/turbo) is a simple solution for getting the performance benefits of a single-page application without the added complexity of a client-side JavaScript framework. MetaTags supports Turbo out of the box, so no configuration is necessary.
+
+In order to update the page title, you can use the following trick. First, set the ID for the `<title>` HTML tag using MetaTags configuration in your initializer `config/initializers/meta_tags.rb`:
+
+```ruby
+MetaTags.configure do |config|
+  config.title_tag_attributes = {id: "page-title"}
+end
+````
 
-### Using with Turbolinks
+Now in your turbo frame, you can update the title using a turbo stream:
 
-[Turbolinks](https://github.com/turbolinks/turbolinks) is a simple solution for getting
-the performance benefits of a single-page application without the added complexity of a
-client-side JavaScript framework. MetaTags supports Turbolinks out of the box, no
-configuration is necessary.
+```html
+<turbo-frame ...>
+    <turbo-stream action="update" target="page-title">
+        <template>My new title</template>
+    </turbo-stream>
+</turbo-frame>
+```
 
 ### Using with pjax
 
-[jQuery.pjax](https://github.com/defunkt/jquery-pjax) is a nice solution for navigation
-without full page reload. The main difference is that layout file will not be rendered,
-so page title will not change. To fix this, when using a page fragment, pjax will check
-the fragment DOM element for a `title` or `data-title` attribute and use any value it finds.
+[jQuery.pjax](https://github.com/defunkt/jquery-pjax) is a nice solution for navigation without a full-page reload. The main difference is that the layout file will not be rendered, so the page title will not change. To fix this, when using a page fragment, pjax will check the fragment DOM element for a `title` or `data-title` attribute and use any value it finds.
 
-MetaTags simplifies this with `display_title` method, which returns fully resolved
-page title (include site, prefix/suffix, etc.) But in this case you will have to
-set default parameters (e.g, `:site`) both in layout file and in your views. To minimize
-code duplication, you can define a helper in `application_helper.rb`:
+MetaTags simplifies this with the `display_title` method, which returns the fully resolved page title (including site, prefix/suffix, etc.). But in this case, you will have to set default parameters (e.g., `:site`) both in the layout file and in your views. To minimize code duplication, you can define a helper in `application_helper.rb`:
 
 ```ruby
 def default_meta_tags
@@ -276,7 +274,7 @@ def default_meta_tags
 end
 ```
 
-Then in your layout file use:
+Then, in your layout file, use:
 
 ```erb
 <%= display_meta_tags(default_meta_tags) %>
@@ -285,7 +283,7 @@ Then in your layout file use:
 And in your pjax templates:
 
 ```erb
-<!-- set title here, so we can use it both in "display_title" and in "title" -->
+<!-- set title here so we can use it both in "display_title" and in "title" -->
 <% title "My Page title" %>
 <%= content_tag :div, data: { title: display_title(default_meta_tags) } do %>
     <h1><%= title %></h1>
@@ -297,9 +295,7 @@ And in your pjax templates:
 
 ### Titles
 
-Page titles are very important for Search engines. The titles in the
-browser are displayed in the title bar. The search engines look at
-the title bar to determine what the page is all about.
+Page titles are very important for search engines. The titles in the browser are displayed in the title bar. Search engines look at the title bar to determine what the page is all about.
 
 ```ruby
 set_meta_tags title: "Member Login"
@@ -310,7 +306,7 @@ set_meta_tags site: "Site Title", title: "Member Login", reverse: true
 # <title>Member Login | Site Title</title>
 ```
 
-Recommended title tag length: up to <b>70 characters</b>, <b>10 words</b>.
+Recommended title tag length: up to **70 characters** in **10 words**.
 
 Further reading:
 
@@ -318,17 +314,16 @@ Further reading:
 
 ### Description
 
-Description tags are called meta tags as they are not displayed by the
-browsers unlike the titles. However, these descriptions may be displayed by
-some search engines. They are used to describe the contents of a page in
-2 or 3 sentences.
+Description meta tags are not displayed by browsers, unlike titles. However, some search engines may choose to display them. These tags are utilized to provide a concise summary of a webpage's content, typically within 2 or 3 sentences.
+
+Below is an example of how to set a description tag using Ruby:
 
 ```ruby
-set_meta_tags description: "All text about keywords, other keywords"
-# <meta name="description" content="All text about keywords, other keywords">
+set_meta_tags description: "This is a sample description"
+# <meta name="description" content="This is a sample description">
 ```
 
-Recommended description tag length: up to <b>300 characters</b>.
+It is advisable to limit the length of the description tag to **300 characters**.
 
 Further reading:
 
@@ -337,24 +332,21 @@ Further reading:
 
 ### Keywords
 
-Meta keywords tag are used to place your keywords that you think a
-surfer would search in Search engines. Repeating keywords unnecessarily
-would be considered spam and you may get permanently banned from SERP's
+Meta keywords tags are used to place keywords that you believe users would search for in search engines. It is important to avoid unnecessary repetition of keywords, as this could be considered spam and may result in a permanent ban from search engine results pages (SERPs).
 
 ```ruby
-set_meta_tags keywords: %w[keyword1 Keyword2 KeyWord3]
+set_meta_tags keywords: %w[keyword1 keyword2 keyword3]
 # <meta name="keywords" content="keyword1, keyword2, keyword3">
 ```
 
-Recommended keywords tag length: up to <b>255 characters</b>, <b>20 words</b>.
+It is recommended to keep the length of the keywords tag under **255 characters** or **20 words**.
 
-**Please note**, that both Google and Bing publicly indicated that keywords
-meta tags is completely ignored.
+> [!NOTE]
+> Both Google and Bing have publicly stated that they completely ignore keywords meta tags.
 
 ### Noindex
 
-By using the noindex meta tag, you can signal to search engines to not
-include specific pages in their indexes.
+By using the noindex meta tag, you can signal to search engines not to include specific pages in their indexes.
 
 ```ruby
 set_meta_tags noindex: true
@@ -372,7 +364,7 @@ Further reading:
 
 ### Index
 
-Although it is not required to add "index" to "robots" as it is default value for Google, some SEO specialists recommend to add it to website
+Although it is not required to add "index" to "robots" as it is the default value for Google, some SEO specialists recommend adding it to the website.
 
 ```ruby
 set_meta_tags index: true
@@ -381,10 +373,7 @@ set_meta_tags index: true
 
 ### Nofollow
 
-Nofollow meta tag tells a search engine not to follow the links on a specific
-page. It's entirely likely that a robot might find the same links on some
-other page without a nofollow (perhaps on some other site), and so
-still arrives at your undesired page.
+Nofollow meta tags tell a search engine not to follow the links on a specific page. It is entirely possible that a robot might find the same links on another page without a nofollow attribute, perhaps on another site, and still arrive at your undesired page.
 
 ```ruby
 set_meta_tags nofollow: true
@@ -400,24 +389,21 @@ Further reading:
 
 ### Follow
 
-Follow will work with Noindex meta tag
+You can use the Noindex meta tag in conjunction with Follow.
 
 ```ruby
 set_meta_tags noindex: true, follow: true
 # <meta name="robots" content="noindex, follow">
 ```
 
-It will not look at this page but will crawl through the rest of the pages on
-your website.
+This tag will prevent search engines from indexing this specific page, but it will still allow them to crawl and index the remaining pages on your website.
 
 ### Canonical URL
 
-Canonical link element tells a search engine what is the canonical or main URL
-for a content which have multiple URLs. The search engine will always return
-that URL, and link popularity and authority will be applied to that URL.
+Canonical link elements tell search engines what the canonical or main URL is for content that has multiple URLs. The search engine will always return that URL, and link popularity and authority will be applied to that URL.
 
-Note: If you like follow a hint of John Mueller that you shouldn't mix canonical with noindex, then you can
-set `MetaTags.config.skip_canonical_links_on_noindex = true` and we'll handle it for you.
+> [!NOTE]
+> If you follow John Mueller's suggestion not to mix canonical with noindex, then you can set `MetaTags.config.skip_canonical_links_on_noindex = true` and we'll handle it for you.
 
 ```ruby
 set_meta_tags canonical: "http://yoursite.com/canonical/url"
@@ -431,9 +417,7 @@ Further reading:
 
 ### Icon
 
-A favicon (short for Favorite icon), also known as a shortcut icon, Web site
-icon, tab icon or bookmark icon, is a file containing one or more small icons,
-most commonly 16×16 pixels, associated with a particular website or web page.
+A favicon (short for Favorite icon), also known as a shortcut icon, website icon, tab icon, or bookmark icon, is a file containing one or more small icons, most commonly 16x16 pixels, associated with a particular website or web page.
 
 ```ruby
 set_meta_tags icon: "/favicon.ico"
@@ -455,8 +439,7 @@ Further reading:
 
 ### Multi-regional and multilingual URLs, RSS and mobile links
 
-Alternate link elements tell a search engine when there is content that's
-translated or targeted to users in a certain region.
+Alternate link elements tell a search engine when there is content that's translated or targeted to users in a certain region.
 
 ```ruby
 set_meta_tags alternate: {"fr" => "http://yoursite.fr/alternate/url"}
@@ -486,9 +469,7 @@ Further reading:
 
 ### Pagination links
 
-Previous and next links indicate indicate the relationship between individual
-URLs. Using these attributes is a strong hint to Google that you want us to
-treat these pages as a logical sequence.
+Previous and next links indicate the relationship between individual URLs. Using these attributes is a strong hint to Google that you want us to treat these pages as a logical sequence.
 
 ```ruby
 set_meta_tags prev: "http://yoursite.com/url?page=1"
@@ -504,10 +485,7 @@ Further reading:
 
 ### image_src links
 
-Basically, when you submit/share this to Facebook , this helps Facebook determine
-which image to put next to the link. If this is not present, Facebook tries to
-put in the first image it finds on the page, which may not be the best one to
-represent your site.
+Basically, when you submit/share this to Facebook, it helps Facebook determine which image to put next to the link. If this is not present, Facebook tries to put in the first image it finds on the page, which may not be the best one to represent your site.
 
 ```ruby
 set_meta_tags image_src: "http://yoursite.com/icons/icon_32.png"
@@ -516,22 +494,22 @@ set_meta_tags image_src: "http://yoursite.com/icons/icon_32.png"
 
 ### amphtml links
 
-AMP is a way to build web pages for static content that render fast. If you have
-two versions of the page – non-AMP and AMP, you can link the AMP version from
-normal one using `amphtml` tag:
+AMP is a method of building web pages for static content that renders quickly. If you have two versions of a page - non-AMP and AMP - you can link the AMP version from the normal one using the `amphtml` tag:
 
 ```ruby
 set_meta_tags amphtml: url_for(format: :amp, only_path: false)
 # <link rel="amphtml" href="https://www.example.com/document.amp">
 ```
 
-To link back to normal version, use `canonical`.
+To link back to the normal version, use the `canonical` tag.
 
 - [What Is AMP?](https://www.ampproject.org/learn/about-amp/)
 - [Make Your Page Discoverable](https://www.ampproject.org/docs/guides/discovery)
 
 ### Manifest links
 
+By including the `rel="manifest"` attribute in the `<link>` element of an HTML page, you can specify the location of the manifest file that describes the web application. This allows the browser to understand that the web page is an application and to provide features like offline access and the ability to add the application to the home screen of a mobile device.
+
 ```ruby
 set_meta_tags manifest: "manifest.json"
 # <link rel="manifest" href="manifest.json">
@@ -541,12 +519,7 @@ set_meta_tags manifest: "manifest.json"
 
 ### Refresh interval and redirect URL
 
-Meta refresh is a method of instructing a web browser to automatically
-refresh the current web page or frame after a given time interval. It is also
-possible to instruct the browser to fetch a different URL when the page is
-refreshed, by including the alternative URL in the content parameter. By
-setting the refresh time interval to zero (or a very low value), this allows
-meta refresh to be used as a method of URL redirection.
+Meta refresh is a method of instructing a web browser to automatically refresh the current web page or frame after a given time interval. It is also possible to instruct the browser to fetch a different URL when the page is refreshed, by including the alternative URL in the content parameter. By setting the refresh time interval to zero (or a very low value), this allows meta refresh to be used as a method of URL redirection.
 
 ```ruby
 set_meta_tags refresh: 5
@@ -562,7 +535,7 @@ Further reading:
 
 ### Open Search
 
-Open Search link element to describe a search engine in a standard and accessible format.
+Open Search is a link element used to describe a search engine in a standard and accessible format.
 
 ```ruby
 set_meta_tags open_search: {
@@ -579,7 +552,7 @@ Further reading:
 
 ### Hashes
 
-Any namespace can be built just passing any symbol name and a Hash. For example:
+Any namespace can be created by simply passing a symbol name and a Hash. For example:
 
 ```ruby
 set_meta_tags foo: {
@@ -594,7 +567,7 @@ set_meta_tags foo: {
 
 ### Arrays
 
-Repeated meta tags can be built just using an Array inside a Hash. For example:
+Repeated meta tags can be easily created by using an Array within a Hash. For example:
 
 ```ruby
 set_meta_tags og: {
@@ -606,10 +579,7 @@ set_meta_tags og: {
 
 ### Open Graph
 
-To turn your web pages into graph objects, you'll need to add Open Graph
-protocol `<meta>` tags to your webpages. The tags allow you to specify
-structured information about your web pages. The more information you provide, the more opportunities your web pages can be surfaced within Facebook today
-and in the future. Here's an example for a movie page:
+To turn your web pages into graph objects, you'll need to add Open Graph protocol `<meta>` tags to your webpages. The tags allow you to specify structured information about your web pages. The more information you provide, the more opportunities your web pages can be surfaced within Facebook today and in the future. Here's an example for a movie page:
 
 ```ruby
 set_meta_tags og: {
@@ -684,8 +654,7 @@ Further reading:
 
 ### Twitter Cards
 
-Twitter cards make it possible for you to attach media experiences to Tweets that link to your content.
-There are 3 card types (summary, photo and player). Here's an example for summary:
+Twitter cards make it possible for you to attach media experiences to Tweets that link to your content. There are 3 card types (summary, photo, and player). Here's an example for summary:
 
 ```ruby
 set_meta_tags twitter: {
@@ -696,9 +665,9 @@ set_meta_tags twitter: {
 # <meta name="twitter:site" content="@username">
 ```
 
-Take in consideration that if you're already using OpenGraph to describe data on your page, it’s easy to generate a Twitter card without duplicating your tags and data. When the Twitter card processor looks for tags on your page, it first checks for the Twitter property, and if not present, falls back to the supported Open Graph property. This allows for both to be defined on the page independently, and minimizes the amount of duplicate markup required to describe your content and experience.
+Take into consideration that if you're already using OpenGraph to describe data on your page, it’s easy to generate a Twitter card without duplicating your tags and data. When the Twitter card processor looks for tags on your page, it first checks for the Twitter property, and if not present, falls back to the supported Open Graph property. This allows both to be defined on the page independently and minimizes the amount of duplicate markup required to describe your content and experience.
 
-When you need to generate a [Twitter Photo card](https://dev.twitter.com/docs/cards/types/photo-card), `twitter:image` property is a string, while image dimensions are specified using `twitter:image:width` and `twitter:image:height`, or a `Hash` objects in terms of MetaTags gems. There is a special syntax to make this work:
+When you need to generate a [Twitter Photo card](https://dev.twitter.com/docs/cards/types/photo-card), the `twitter:image` property is a string, while image dimensions are specified using `twitter:image:width` and `twitter:image:height`, or a `Hash` object in terms of MetaTags gems. There is a special syntax to make this work:
 
 ```ruby
 set_meta_tags twitter: {
@@ -715,7 +684,7 @@ set_meta_tags twitter: {
 # <meta name="twitter:image:height" content="100">
 ```
 
-Special parameter `itemprop` can be used on a "anonymous" tag "\_" to generate "itemprop" HTML attribute:
+A special parameter `itemprop` can be used on an "anonymous" tag "\_" to generate the "itemprop" HTML attribute:
 
 ```ruby
 set_meta_tags twitter: {
@@ -739,7 +708,7 @@ Further reading:
 
 ### App Links
 
-App Links is an open cross platform solution for deep linking to content in your mobile app. Here's an example for iOS app integration:
+App Links is an open cross-platform solution for deep linking to content in your mobile app. Here's an example of iOS app integration:
 
 ```ruby
 set_meta_tags al: {
@@ -760,8 +729,7 @@ Further reading:
 
 ### Custom meta tags
 
-Starting from version 1.3.1, you can specify arbitrary meta tags, and they will
-be rendered on the page, even if meta-tags gem does not know about them.
+Starting from version 1.3.1, you can specify arbitrary meta tags, and they will be rendered on the page, even if the meta-tags gem does not know about them.
 
 Example:
 
@@ -770,8 +738,7 @@ set_meta_tags author: "Dmytro Shteflyuk"
 # <meta name="author" content="Dmytro Shteflyuk">
 ```
 
-You can also specify value as an Array, and values will be displayed as a list
-of `meta` tags:
+You can also specify the value as an Array, and the values will be displayed as a list of `meta` tags:
 
 ```ruby
 set_meta_tags author: ["Dmytro Shteflyuk", "John Doe"]
@@ -781,4 +748,4 @@ set_meta_tags author: ["Dmytro Shteflyuk", "John Doe"]
 
 ## Maintainers
 
-[Dmytro Shteflyuk](https://github.com/kpumuk), [https://kpumuk.info](http://kpumuk.info/)
+[Dmytro Shteflyuk](https://github.com/kpumuk), [https://dmytro.sh](https://dmytro.sh)

data/Rakefile

@@ -10,14 +10,6 @@ desc "Run RSpec tests"
 task test: :spec
 task default: :spec
 
-desc "Rebuild Circle CI configuration based on the build matrix template .circleci/config.yml.erb"
-task :circleci do
-  require "erb"
-  template_path = File.expand_path(".circleci/config.yml.erb", __dir__)
-  config_path = File.expand_path(".circleci/config.yml", __dir__)
-  File.write config_path, ERB.new(File.read(template_path)).result
-end
-
 module SteepRunner
   def self.run(*command)
     require "steep"

data/lib/generators/meta_tags/templates/config/initializers/meta_tags.rb

@@ -9,6 +9,12 @@ MetaTags.configure do |config|
   # When true, site title will be truncated instead of title. Default is false.
   # config.truncate_site_title_first = false
 
+  # Add HTML attributes to the <title> HTML tag. Default is {}.
+  # config.title_tag_attributes = {}
+
+  # Add HTML attributes to the <title> HTML tag. Default is {}.
+  # config.title_tag_attributes = {}
+
   # Maximum length of the page description. Default is 300.
   # Set to nil or 0 to remove limits.
   # config.description_limit = 300

data/lib/meta_tags/configuration.rb

@@ -6,9 +6,15 @@ module MetaTags
     # How many characters to truncate title to.
     attr_accessor :title_limit
 
+    # HTML attributes for the title tag.
+    attr_accessor :title_tag_attributes
+
     # Truncate site_title instead of title.
     attr_accessor :truncate_site_title_first
 
+    # A string or regexp separator to truncate text at a natural break.
+    attr_accessor :truncate_on_natural_separator
+
     # How many characters to truncate description to.
     attr_accessor :description_limit
 
@@ -76,6 +82,8 @@ module MetaTags
     def reset_defaults!
       @title_limit = 70
       @truncate_site_title_first = false
+      @truncate_on_natural_separator = " "
+      @title_tag_attributes = {}
       @description_limit = 300
       @keywords_limit = 255
       @keywords_separator = ", "