smartmustache/README.md

42 lines
2.2 KiB
Markdown
Raw Normal View History

2016-11-20 11:35:46 +00:00
# tlt
templates done right
2016-11-20 16:54:13 +00:00
## Availabililty
2017-02-25 22:40:15 +00:00
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/tlt)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/tlt)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/tlt)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/tlt/)
2016-11-20 16:54:13 +00:00
## Status for master
2017-02-25 22:40:15 +00:00
[![build status](https://GitLab.com/pushrocks/tlt/badges/master/build.svg)](https://GitLab.com/pushrocks/tlt/commits/master)
[![coverage report](https://GitLab.com/pushrocks/tlt/badges/master/coverage.svg)](https://GitLab.com/pushrocks/tlt/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/tlt.svg)](https://www.npmjs.com/package/tlt)
2016-11-20 16:54:13 +00:00
[![Dependency Status](https://david-dm.org/pushrocks/tlt.svg)](https://david-dm.org/pushrocks/tlt)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/tlt/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/tlt/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/tlt/badges/code.svg)](https://www.bithound.io/github/pushrocks/tlt)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
2016-11-20 11:35:46 +00:00
## Usage
2017-02-25 22:40:15 +00:00
Use TypeScript for best in class instellisense.
2016-11-20 11:35:46 +00:00
```javascript
2016-11-20 16:41:26 +00:00
import { Tlt } from 'tlt'
2016-11-20 11:35:46 +00:00
2016-11-20 16:44:56 +00:00
let myTlt = new Tlt('my {{somePlaceholder}} are {{anotherPlaceholder}}!')
let appliedString = myTlt.applyData({
"somePlaceholder": "horses",
"anotherPlaceholder": "awesome"
2016-11-20 11:35:46 +00:00
})
2016-11-20 16:44:56 +00:00
// appliedString will be 'my horses are awesome!'
2016-11-20 16:54:13 +00:00
```
2017-02-25 22:40:15 +00:00
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)