Skip to content

Commit 8582263

Browse files
committed
- Added README.md
1 parent e59133f commit 8582263

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
This project aims to contain several definitions of common node.js libraries
2+
for TypeScript language in order to have autocomplete support.
3+
4+
It would be great if the creators of node modules, include definition files
5+
directly on their projects. In the meanwhile this project will do the job.
6+
7+
You can perform pull requests improving definitions or adding new ones.
8+
I will add them ASAP.
9+
10+
In order to be able to use it easily, you can create a git submodule for
11+
your poject adding this in the .gitmodules file:
12+
13+
```
14+
[submodule "typescript-node-definitions"]
15+
path = typescript-node-definitions
16+
url = git://github.com/soywiz/typescript-node-definitions.git
17+
```
18+
19+
Also you can create a "app.d.ts" file or similar including all the
20+
definitions file that are you using in your project:
21+
22+
```
23+
///<reference path='typescript-node-definitions/node.d.ts'/>
24+
///<reference path='typescript-node-definitions/mongodb.d.ts'/>
25+
///<reference path='typescript-node-definitions/express3.d.ts'/>
26+
///<reference path='typescript-node-definitions/consolidate.d.ts'/>
27+
```

0 commit comments

Comments
 (0)