Skip to content

Commit 3bdd27c

Browse files
authored
Add a section about TypeScript defs in README
Since TypeScript usage has exploded the last years but this is package is written in JavaScript, we might at least reference the external DefinitelyTyped package @types/mustache that has a somewhat up-to-date set of type definitions for most of the package.
1 parent 7f94f13 commit 3bdd27c

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,11 @@ $ rake yui3
534534
$ rake qooxdoo
535535
```
536536

537+
## TypeScript
538+
539+
Since the source code of this package is written in JavaScript, we follow the [TypeScript publishing docs](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) preferred approach
540+
by having type definitions available via [@types/mustache](https://www.npmjs.com/package/@types/mustache).
541+
537542
## Testing
538543

539544
In order to run the tests you'll need to install [Node.js](http://nodejs.org/).

0 commit comments

Comments
 (0)