definition-header/README.md

DefinitelyTyped definition header tools

# definition-header

[![Build Status](https://secure.travis-ci.org/DefinitelyTyped/definition-header.svg?branch=master)](http://travis-ci.org/DefinitelyTyped/definition-header) [![NPM version](https://badge.fury.io/js/definition-header.svg)](http://badge.fury.io/js/definition-header) [![Dependency Status](https://david-dm.org/DefinitelyTyped/definition-header.svg)](https://david-dm.org/DefinitelyTyped/definition-header) [![devDependency Status](https://david-dm.org/DefinitelyTyped/definition-header/dev-status.svg)](https://david-dm.org/DefinitelyTyped/definition-header#info=devDependencies)

> DefinitelyTyped definition header utils

Work with the headers in the definition files in the [DefinitelyTyped](https://github.com/borisyankov/DefinitelyTyped) repository. 

Bundles a parser, serialiser, interfaces, assertions and some utilities.

:warning: Under construction, in-consistent, tests incomplete... :sunglasses:

#### Type export

This module is also test to figure out how to export type-info in a npm module (like via package.json etc).

## Format

Classic header (from the [wiki](https://github.com/borisyankov/DefinitelyTyped/wiki/How-to-contribute))

````
// Type definitions for [LIBRARY NAME]
// Project: [LIBRARY URL]
// Definitions by: [AUTHOR NAME] <[AUTHOR URL]>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
````

## Build

Install development dependencies in your git checkout:

````bash
$ npm install
````

Build and run tests using [grunt](http://gruntjs.com):

````bash
$ npm test
````

See the `Gruntfile.js` for additional commands.

## History

- 0.0.1 - First release

## License

Copyright (c) 2014 Bart van der Schoor @ [DefinitelyTyped](https://github.com/DefinitelyTyped)

Licensed under the MIT license.