From 3bdd27c4e762f665232dc46186c7639e60dbd70e Mon Sep 17 00:00:00 2001 From: Phillip Johnsen Date: Sat, 11 Jan 2020 22:00:50 +0100 Subject: [PATCH] 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. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 0695032..9c79082 100644 --- a/README.md +++ b/README.md @@ -534,6 +534,11 @@ $ rake yui3 $ rake qooxdoo ``` +## TypeScript + +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 +by having type definitions available via [@types/mustache](https://www.npmjs.com/package/@types/mustache). + ## Testing In order to run the tests you'll need to install [Node.js](http://nodejs.org/).