.template/README.mustache
---
azurePipelines:
badgeURL: https://dev.azure.com/sounisi5011/npm%20projects/_apis/build/status/sounisi5011.glob-replacer?branchName=master
pageURL: https://dev.azure.com/sounisi5011/npm%20projects/_build/latest?definitionId=8&branchName=master
codeClimate:
maintainabilityBadgeURL: https://api.codeclimate.com/v1/badges/6de5b71bca2a9c087912/maintainability
---
# {{{pkg.name}}}
{{^pkg.private}}
[![Go to the latest release page on npm](https://img.shields.io/npm/v/{{{pkg.name}}}.svg)](https://www.npmjs.com/package/{{{pkg.name}}})
{{/pkg.private}}
[![License: {{{pkg.license}}}](https://img.shields.io/static/v1?label=license&message={{#encURL}} {{{pkg.license}}} {{/encURL}}&color=green)]({{{githubFileRoot}}}/LICENSE)
![Supported Node.js version: {{{pkg.engines.node}}}](https://img.shields.io/static/v1?label=node&message={{#encURL}} {{{pkg.engines.node}}} {{/encURL}}&color=brightgreen)
![Type Definitions: TypeScript](https://img.shields.io/static/v1?label=types&message=TypeScript&color=blue)
{{^pkg.private}}
[![Minified Bundle Size Details](https://img.shields.io/bundlephobia/min/{{{pkg.name}}}/{{{pkg.version}}})](https://bundlephobia.com/result?p={{{pkg.name}}}@{{{pkg.version}}})
[![Install Size Details](https://packagephobia.now.sh/badge?p={{{pkg.name}}}@{{{pkg.version}}})](https://packagephobia.now.sh/result?p={{{pkg.name}}}@{{{pkg.version}}})
{{/pkg.private}}
[![Dependencies Status](https://david-dm.org/{{{repo.owner}}}/{{{repo.name}}}/status.svg)](https://david-dm.org/{{{repo.owner}}}/{{{repo.name}}})
{{#azurePipelines}}
[![Build Status]({{{azurePipelines.badgeURL}}})]({{{azurePipelines.pageURL}}})
{{/azurePipelines}}
{{#codeClimate}}
{{#codeClimate.maintainabilityBadgeURL}}
[![Maintainability Status]({{{codeClimate.maintainabilityBadgeURL}}})](https://codeclimate.com/github/{{{repo.owner}}}/{{{repo.name}}}/maintainability)
{{/codeClimate.maintainabilityBadgeURL}}
{{#codeClimate.testCoverageBadgeURL}}
[![Test Coverage Status]({{{codeClimate.testCoverageBadgeURL}}})](https://codeclimate.com/github/{{{repo.owner}}}/{{{repo.name}}}/test_coverage)
{{/codeClimate.testCoverageBadgeURL}}
{{/codeClimate}}
{{{pkg.description}}}
## Install
Note: **This library is incomplete. Please install at your own risk.**
```sh
npm install github:{{{repo.owner}}}/{{{repo.name}}}
```
## Usage
WIP. There is no code available.
## Tests
To run the test suite, first install the dependencies, then run `npm test`:
```sh
npm install
npm test
```
## Contributing
see [CONTRIBUTING.md]({{{repo.rootURL}}}/blob/master/CONTRIBUTING.md)