diff --git a/README.md b/README.md index aadcbb44e..f1ec0f160 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,9 @@ Just run: ember install ember-cli-typescript@1 ``` -All dependencies will be added to your `package.json`, and you're ready to roll! (If you're upgrading from a previous release, you should check to merge any tweaks you've made to `tsconfig.json`. +All dependencies will be added to your `package.json`, and you're ready to roll! +(If you're upgrading from a previous release, you should check to merge any +tweaks you've made to `tsconfig.json`. In addition to ember-cli-typescript, the following are installed: @@ -99,9 +101,9 @@ This interface will likely require some changes to match your app. ## :construction: Using ember-cli-typescript with Ember CLI addons -**:warning: Warning: this is *not* currently recommended. This is a WIP part of the -add-on, and it *will* make a dramatic difference in the size of your add-on in -terms of installation. The upcoming 1.1 release will enable a much better +**:warning: Warning: this is *not* currently recommended. This is a WIP part of +the add-on, and it *will* make a dramatic difference in the size of your add-on +in terms of installation. The upcoming 1.1 release will enable a much better experience for consumers of your addon.** We're working on making a solution that lets us ship generated typings and @@ -114,12 +116,6 @@ give users fair warning about the increased size. To enable TypeScript for your addon, simple move `ember-cli-typescript` from `devDependencies` to `dependencies` in your `package.json`. -## New modules API - -Note: the new modules API is not yet supported by the official typings (which -are distinct from this addon, though we install them). We hope to have support -for them shortly! - ## Not (yet) supported While TS already works nicely for many things in Ember, there are a number of @@ -129,15 +125,23 @@ landing in TypeScript itself. [existing typings]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember -We are hard at work (and would welcome your help!) [writing new typings] for -Ember which can give correct types for Ember's custom object model. If you'd -like to try those out, please see instructions in that repo! +We are hard at work (and would welcome your help!) [writing new +typings][ember-typings] for Ember and the surrounding ecosystem, which can give +correct types for Ember's custom object model and things which build on it (e.g. +ember-data). If you'd like to try those out, please see instructions in [that +repo][ember-typings]! -[writing new typings]: https://github.com/typed-ember/ember-typings +[ember-typings]: https://github.com/typed-ember/ember-typings Here is the short list of things which do *not* work yet in the version of the typings published on DefinitelyTyped. +### New modules API + +Note: the new modules API is not yet supported by the official typings (which +are distinct from this addon, though we install them). We do have experimental +support for them in the [ember-typings] repository, and it works quite well! + ### Some `import`s don't resolve You'll frequently see errors for imports which TypeScript doesn't know how to diff --git a/package.json b/package.json index 49d9422e8..535c420f8 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,7 @@ "broccoli-plugin": "^1.2.1", "broccoli-source": "^1.1.0", "broccoli-stew": "^1.4.0", - "broccoli-typescript-compiler": "^2.0.0", + "broccoli-typescript-compiler": "^2.1.0", "debug": "^2.2.0", "ember-cli-babel": "^6.3.0", "silent-error": "^1.1.0"