Merge pull request #189 from typed-ember/changelog-and-readme

Update CHANGELOG and README

Author: chriskrycho

CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+### Changed
+
+* Clarified instructions for sourcemaps.
+
+### Fixed
+
+* TypeScript no longer churns on every change in the `tmp` directory.
+* Make sure ember-cli-typescript is a dev dependency when generating in-repo-addons, so their TypeScript gets built correctly.
+* Eliminated some lint errors in the build.
+
 ## [1.2.1] - 2018-03-14
 
 ### Fixed
@@ -17,8 +27,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 ### Added
 
 * Blueprint (and tests) to generate in-repo addons configured for TypeScript
-* @ts-ignore component template import.
-* -addon blueprints for all the things to generate .ts files in `app/` in an addon.
+* Add `// @ts-ignore` component template import.
+* `-addon` blueprints for all the things to generate .ts files in `app/` in an addon.
 
 ### Changed
 

README.md

@@ -6,6 +6,7 @@ Use TypeScript in your Ember 2.x and 3.x apps!
 
 * [Setup and Configuration](#setup-and-configuration)
   * [Ember Support](#ember-support)
+      * [:construction: Ember 3.1](#construction-ember-31)
   * [`tsconfig.json`](#tsconfigjson)
   * [Sourcemaps](#sourcemaps)
 * [Using TypeScript with Ember effectively](#using-typescript-with-ember-effectively)
@@ -67,6 +68,12 @@ In addition to ember-cli-typescript, we make the following changes to your proje
 
 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.
 
+#### :construction: Ember 3.1
+
+Support for (mostly in the form of documentation!) for the changes in Ember 3.1 is inbound shortly. You *can* use this addon with Ember 3.1, but the docs are not yet updated, and some of the patterns recommended below will actually cause your app to break. :grimacing: Come ping us in #topic-typescript in the [Ember Community Slack][Slack] and we'll help you. (And updated docs for 3.1 are inbound *soon*!)
+
+[Slack]: https://ember-community-slackin.herokuapp.com
+
 ### `tsconfig.json`
 
 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.
@@ -628,7 +635,7 @@ import { task } from 'ember-concurrency';
 
 You'll see an error, because there aren't yet type definitions for it. You may see the same with some addons as well. **These won't stop the build from working;** they just mean TypeScript doesn't know where to find those.
 
-Writing these missing type definitions is a great way to pitch in! Jump in \#topic-typescript on the Ember Slack and we'll be happy to help you.
+Writing these missing type definitions is a great way to pitch in! Jump in \#topic-typescript on the [Ember Slack][Slack] and we'll be happy to help you.
 
 ### Type safety when invoking actions