Move mdast types to dev dependencies

Closes GH-41. Reviewed-by: Titus Wormer <[email protected]>
syntax-tree · May 1, 2020 · 3e30b29 · 3e30b29
1 parent 8548e60
commit 3e30b29
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -31,7 +31,6 @@
   ],
   "types": "types/index.d.ts",
   "dependencies": {
-    "@types/mdast": "^3.0.0",
     "collapse-white-space": "^1.0.0",
     "detab": "^2.0.0",
     "mdast-util-definitions": "^3.0.0",
@@ -43,6 +42,7 @@
     "unist-util-visit": "^2.0.0"
   },
   "devDependencies": {
+    "@types/mdast": "^3.0.0",
     "browserify": "^16.0.0",
     "dtslint": "^3.0.0",
     "nyc": "^15.0.0",

diff --git a/readme.md b/readme.md
@@ -20,6 +20,12 @@
 npm install mdast-util-to-hast
 ```
 
+[npm][] with [TypeScript][] support:
+
+```sh
+npm install mdast-util-to-hast @types/mdast
+```
+
 ## Use
 
 Say we have the following `example.md`:
@@ -340,6 +346,8 @@ abide by its terms.
 
 [npm]: https://docs.npmjs.com/cli/install
 
+[typescript]: https://www.typescriptlang.org
+
 [license]: license
 
 [author]: https://wooorm.com