Skip to content

Commit 90d18f0

Browse files
authored
Merge pull request #248 from mike-north/patch-3
Update README w/ TS support policy
2 parents f0ebdf5 + 71a7bb7 commit 90d18f0

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Use TypeScript in your Ember 2.x and 3.x apps!
66

77
* [Getting Help](#getting-help)
88
* [Setup and Configuration](#setup-and-configuration)
9-
* [Ember Support](#ember-support)
9+
* [Supported Ember & TypeScript Versions](#supported-ember-and-typescript-versions)
1010
* [`tsconfig.json`](#tsconfigjson)
1111
* [Sourcemaps](#sourcemaps)
1212
* [Using TypeScript with Ember effectively](#using-typescript-with-ember-effectively)
@@ -105,10 +105,12 @@ In addition to ember-cli-typescript, we make the following changes to your proje
105105
* `types/<app name>/index.d.ts` – the location for any global type declarations you need to write for you own application; see [Global types for your package](#global-types-for-your-package) for information on its default contents and how to use it effectively
106106
* `app/config/environment.d.ts` – a basic set of types defined for the contents of the `config/environment.js` file in your app; see [Environment and configuration typings](#environment-and-configuration-typings) for details
107107

108-
### Ember support
108+
### Supported Ember and TypeScript versions
109109

110110
ember-cli-typescript runs its test suite against the 2.12 LTS, the 2.16 LTS, the 2.18 LTS, the current release, the beta branch, and the canary branch. It's also in active use in several large applications. Any breakage for upcoming releases _should_ be detected and fixed ahead of those releases, but you can help us guarantee that by running your own Ember.js+TypeScript app with beta and canary turned on and let us know if you run into issues with upcoming Ember.js releases.
111111

112+
This library supports the current version of TypeScript [![TS Version](https://img.shields.io/github/tag/Microsoft/typescript.svg?label=latest%20typescript%20release)](https://github.com/Microsoft/TypeScript/releases/latest) and at least one previous minor or major release (i.e., if `3.0` is the latest release, we **do** support `3.0.x`, `2.9.x`, and **might** support `2.8` as well).
113+
112114
### `tsconfig.json`
113115

114116
We generate a good default [`tsconfig.json`][blueprint], which will usually make everything _Just Work™_. In general, you may customize your TypeScript build process as usual using the `tsconfig.json` file.

0 commit comments

Comments
 (0)