From 18eb027b6eba2e0ceffba3f0ca27a259ac35f088 Mon Sep 17 00:00:00 2001 From: aminya Date: Mon, 20 Jul 2020 21:08:03 -0500 Subject: [PATCH] fix: add readme about the types --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 41a9ae24..5c2477a6 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,19 @@ It also provides the TypeScript types for atom-ide packages. Just install and enjoy. +## Using Types +Install the packages as an npm package: +``` +npm install --save-dev atom-ide-base +``` + +Then import the types like the following: +```ts +import {BusySignalServie} from "atom-ide-base" +``` + +See the "*.d.ts" files to become familiar with the API. + ## Contributing - Let me know if you encounter any bugs.