wassname/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/wassname/DefinitelyTyped.git synced 2026-09-09 11:13:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Boris Yankov
2013-01-17 16:32:23 +02:00
parent e45cc5aec1
commit 3c1623624a
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -4
View File
@@ -1,12 +1,27 @@
DefinitelyTyped
===============
TypeScript type definitions repository for popular JavaScript libraries.
The repository for *high quality* TypeScript type definitions.
The project aims to provide *high quality* definitions for the most popular libraries out there.
Use a definition file like this:
Complete
--------
```
/// <reference path="jquery.d.ts" />
```
Contributor Guidelines
----------------------
Definition files should be called 'library.d.ts'.
In case there are multiple versions supported, the latest one will be without a version number in the file name.
Older versions will be in the form of 'library-1.0.d.ts'.
Test files called 'library-tests.ts'.
They are not runnable, in the TDD way.
They contain code that should compile with no errors, usually taken from the documentation.samples of the library.
It is very desirable each new contribution to contain tests too.
List of Libraries
-----------------
* [AngularJS](http://angularjs.org) (by [Diego Vilar](https://github.com/diegovilar)) ([wiki](https://github.com/borisyankov/DefinitelyTyped/wiki/AngularJS-Definitions-Usage-Notes))
* [async](https://github.com/caolan/async) (by [Boris Yankov](https://github.com/borisyankov))
* [Backbone.js](http://backbonejs.org/) (by [Boris Yankov](https://github.com/borisyankov))