Skip to content

Commit

Permalink
docs: rearrange readme
Browse files Browse the repository at this point in the history
  • Loading branch information
knownasilya committed Jun 6, 2020
1 parent 3831ce3 commit f363ce8
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ ember install ember-page-title

Add `{{head-layout}}` to your application's `application.hbs` template.

<details>
<summary>Fastboot vs Non-Fastboot Notes</summary>

#### Post Install Cleanup

As of v3.0.0 this addon maintains the page title by using the `<title>` tag in your document's `<head>`. This is necessary for [FastBoot](https://github.com/tildeio/ember-cli-fastboot) compatibility.
Expand All @@ -18,20 +21,12 @@ As of v3.0.0 this addon maintains the page title by using the `<title>` tag in y

**Fastboot apps** MUST remove the `<title>` tag from index.html.

</details>

### Digging in

[Visit the Docs site](https://adopted-ember-addons.github.io/ember-page-title/)

### Fastboot

When working with other addons that use `ember-cli-head`, you'll need to create a custom `head.hbs` file that exposes the `<title>` tag properly:

```hbs
<title>{{model.title}}</title>
```

This file is added automatically if you use `ember install`. This is for all the folks using ember-cli-head addons like ember-cli-meta-tags.

### API

#### `{{page-title}}` Helper
Expand Down Expand Up @@ -59,6 +54,16 @@ module.exports = function (environment) {
};
```

### Fastboot

When working with other addons that use `ember-cli-head`, you'll need to create a custom `head.hbs` file that exposes the `<title>` tag properly:

```hbs
<title>{{model.title}}</title>
```

This file is added automatically if you use `ember install`. This is for all the folks using ember-cli-head addons like ember-cli-meta-tags.

### Deprecations

- Since **v5.2.2**: The `{{title}}` helper has been deprecated, use `{{page-title}}` instead, it has the same API. The
Expand Down

0 comments on commit f363ce8

Please sign in to comment.