@kibibit/kb-hologram
Create images from templates and data
## how to use
### Installation
```bash
$ npm install --save @kibibit/kb-hologram
```
### Usage
```javascript
import { KbHologram, KbHologramResultType } from "@kibibit/kb-hologram";
const kbHologram = new KbHologram({
fontName: "../Comfortaa-Regular.ttf",
templateName: "changelog-template",
height: 534 * 2,
width: 1069 * 2,
data: {
columnOne: [
"Compact folders in Explorer",
"Edit both files in diff view",
"Search results update while typing",
"Problems panel filtering by type",
"Minimap highlights errors, changes",
"Terminal minimum contrast ratio",
],
columnTwo: [
"Mirror cursor in HTML tags",
"Optional chaining support in JS\\TS",
"Extract to interface TS refactoring",
"Sass module support for @use",
"Remote - Containers improvements",
"Visual Studio Online preview",
],
title: "achievibit",
subtitle: "v2.1.4 - CHANGELOG",
logo: {
url: "data:image/png;base64,",
alt: "kibibit",
},
},
type: "html",
});
const pngBuffer = await kbHologram.render(KbHologramResultType.PngBuffer);
```
Which will return a **png buffer** for the following image:
### Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Stay in touch
- Author - [Neil Kalman](https://github.com/thatkookooguy)
## Contributors
Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing](CONTRIBUTING.MD).
You can check out some easy to start with issues in the [Easy Pick](https://github.com/Kibibit/kb-hologram/labels/Easy%20Pick).
## Contributor Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.
## License
[MIT License](LICENSE)
Copyright (c) 2020 Neil Kalman <neilkalman@gmail.com>