Skip to content

Commit

Permalink
Merge pull request #59 from OCTRI/release-3-docs
Browse files Browse the repository at this point in the history
Update Docs Prior to 3.0.0 Release
  • Loading branch information
heathharrelson authored Oct 24, 2018
2 parents 774fa4d + 05e4404 commit af01f8f
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 14 deletions.
33 changes: 33 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
# Changelog

## 3.0.0

Updates dependencies and migrates to use the new Ember testing APIs.

### Breaking

ember-i18next 3.0.0 drops support for Ember 1.13. The addon has been tested with Ember 2.16 LTS, 2.18 LTS and Ember 3.x, but it should work down to version 2.3.

Version 3.0.0 also updates the i18next dependency to version 11, which contains breaking changes. Review [the i18next migration guide](https://www.i18next.com/misc/migration-guide.html) prior to upgrading.

### Changes Included

* PR #56: Use the new Ember testing API.
* PR #57: Update addon dependency to Ember 3.4.
* PR #58: Update to the latest i18next and i18next-xhr-backend.

## 2.1.1

Updates dependencies.

### Changes Included

* PR #55: Update addon dependencies.

## 2.1.0 2018/04/24

Updates depdendencies and adds a new computed property macro for translated text. See README.md for details on using the new macro.

### Changes Included

* PR #54: Update addon depdendency to Ember 3.0.
* PR #52: Add computed property macro.

## 2.0.0 2018/03/01

Updates dependencies and uses the [Ember.js modules API introduced in Ember 2.16](https://emberjs.com/blog/2017/10/11/ember-2-16-released.html).
Expand Down
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,16 @@

An [Ember CLI](http://www.ember-cli.com/) addon for internationalizing Ember.js applications using the [i18next](http://i18next.com/) library. The addon provides an Ember service that wraps i18next and a Handlebars helper for displaying localized text in templates.

ember-i18next 2.0 only supports Ember.js 1.13 and higher.
ember-i18next supports current Ember (release, beta, canary) and the last two LTS releases. It may work with releases down to Ember 2.3.

## Installation

To install with Ember CLI >= 0.2.3:
To install with Ember CLI:

```bash
ember install ember-i18next
```

To install with Ember CLI 0.1.5 - 0.2.2:

```bash
ember install:addon ember-i18next
```

For older versions:

```bash
npm install --save-dev ember-i18next
```

## Upgrading from ember-i18next 1.X

Bower is no longer used to install i18next. If you are still using Bower with your Ember app, you will need to remove the i18next dependency from `bower.json`.
Expand Down

0 comments on commit af01f8f

Please sign in to comment.