# @hamistudios/crather

> a simple nodejs render engine

Latest version **2.0.2** (published 2018-06-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hamistudios/crather
pnpm add @hamistudios/crather
yarn add @hamistudios/crather
bun add @hamistudios/crather
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2018-06-29 |
| First published | 2018-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 91.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | HamiStudios |
| Maintainers | hammy2899 |
| Keywords | render, engine, express, templates |

## Links

- npm: https://www.npmjs.com/package/@hamistudios/crather
- Repository: https://github.com/HamiStudios/crather
- Homepage: https://github.com/HamiStudios/crather#readme
- Issues: https://github.com/HamiStudios/crather/issues
- npm.io page: https://npm.io/package/@hamistudios/crather

## Dependencies (2)

- [dot-prop](https://npm.io/package/dot-prop.md) ^4.2.0
- [circle-assign](https://npm.io/package/circle-assign.md) ^1.0.3

## Recent versions

- 2.0.2 (latest) — 2018-06-29
- 2.0.1 — 2018-06-21
- 2.0.0 — 2018-06-21
- 1.2.6 — 2018-06-04
- 1.2.5 — 2018-06-02

## README

<p align="center">
  <img src="https://www.hamistudios.com/assets/img/crather_icon_transparent.png">
</p>

<h1 align="center">crather</h1>
<p align="center">a simple <a href="https://nodejs.org">nodejs</a> render engine</p>

<p align="center">
  <a href="https://travis-ci.org/HamiStudios/crather"><img src="https://travis-ci.org/HamiStudios/crather.svg?branch=master"></a>
  <a href="https://coveralls.io/github/HamiStudios/crather?branch=master"><img src="https://coveralls.io/repos/github/HamiStudios/crather/badge.svg?branch=master"></a>
  <a href="https://www.npmjs.com/package/@hamistudios/crather"><img src="https://img.shields.io/npm/v/@hamistudios/crather.svg"></a>
  <a href="https://github.com/hamistudios/crather/blob/master/LICENSE.md"><img src="https://img.shields.io/github/license/hamistudios/crather.svg"></a>
</p>

### Features:

- Can be used to seamlessly with [`express`](https://github.com/expressjs/express) to render views
- Supports templates and scripts to create dynamic content
- Can be used as a standalone render engine which is great for HTML emails
- Can be used to process any file type HTML, CSS, Text you name it

---

## Installation
```
$ npm install --save @hamistudios/crather
```

## Quick start

```crather
<!-- example.crather -->

<h1>{{ message }}</h1>
```

```javascript
// index.js

const Crather = require('@hamistudios/crather');  
  
let crather = new Crather({  
  data: {
    message: 'Hello World'
  }
});

crather.parse('./example.crather', function(err, result) {  
   if(err) console.error(err);  
   else console.log(result.getRendered());  
});
```

Output:
```html
<h1>Hello World</h1>
```

For more help and information head over to our [website](https://crather.hamistudios.com).

## Documentation
You can view all documentation on the [crather website](https://crather.hamistudios.org).

* Getting started  
  * [Quick start](https://crather.hamistudios.org/#/getting-started/quick-start.md)  
  * [Using express](https://crather.hamistudios.org/#/getting-started/express.md)  
  
* Guides  
  * [Standard Expressions](https://crather.hamistudios.org/#/guides/standard-expressions.md)  
  * [Templates](https://crather.hamistudios.org/#/guides/templates.md)  
  * [Scripts](https://crather.hamistudios.org/#/guides/scripts.md)  
  
* Reference  
  * [Crather](https://crather.hamistudios.org/#/reference/Crather.md)  
  * [Result](https://crather.hamistudios.org/#/reference/Result.md)  
  * [Crather.script](https://crather.hamistudios.org/#/reference/Crather.script.md)  
  * [Expression](https://crather.hamistudios.org/#/reference/Expression.md)
    
* [Changelog](https://crather.hamistudios.org/#/CHANGELOG.md)

---
_Source: https://npm.io/package/@hamistudios/crather · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._