diff --git a/README.md b/README.md index 31d7503..141ca9f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,18 @@ # CSDLParser -======== [![Build Status](https://travis-ci.org/pboyd04/CSDLParser.svg?branch=master)](https://travis-ci.org/pboyd04/CSDLParser) [![Dependency Status](https://david-dm.org/pboyd04/CSDLParser.svg)](https://david-dm.org/pboyd04/CSDLParser) + +--- + +## Installation + +This module is installed via npm: + +``` +npm install --save CSDLParser +``` + +## Description + +This module provides a simple interface to parse [Common Schema Definition Language](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part3-csdl.html) (CSDL) files as defined by the OData v4 specification. This module was originally written to provide a more comprehensive test suite for projects utilizing CSDL for typing, but could also be used by OData clients to obtain type information.