fix: add readme about the types

atom-community · Jul 21, 2020 · 18eb027 · 18eb027
1 parent b99f92b
commit 18eb027
Showing 1 changed file with 13 additions and 0 deletions.
diff --git 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.