diff --git a/README.md b/README.md index 28a4b19e3e..eabf364960 100644 --- a/README.md +++ b/README.md @@ -216,7 +216,7 @@ If default imports work in your environment, consider turning on the [`--allowSy Do not change the type definition if it is accurate. For an NPM package, `export =` is accurate if `node -p 'require("foo")'` is the export, and `export default` is accurate if `node -p 'require("foo").default'` is the export. -#### I want to use features from TypeScript 2.1. +#### I want to use features from TypeScript 2.1 or above. Then you will have to add a comment to the last line of your definition header (after `// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped`): `// TypeScript Version: 2.1`. @@ -258,6 +258,11 @@ transitively `react-router-bootstrap` (which depends on `react-router`) also add Also, `/// ` will not work with path mapping, so dependencies must use `import`. +#### What about scoped packages? + +Types for a scoped package `@foo/bar` should go in `types/foo__bar`. Note the double underscore. + + #### The file history in GitHub looks incomplete. GitHub doesn't [support](http://stackoverflow.com/questions/5646174/how-to-make-github-follow-directory-history-after-renames) file history for renamed files. Use [`git log --follow`](https://www.git-scm.com/docs/git-log) instead.