From acfd2c941b671815860347c82bcd0a8b6227a131 Mon Sep 17 00:00:00 2001 From: thatkookooguy Date: Wed, 25 Dec 2019 15:07:49 +0200 Subject: [PATCH 1/3] fix(readme): add readme text --- README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 83 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6b2be52..41557e6 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,87 @@

- -GENERAL DESCRIPTION IF NEEDED +## how to use -
Icons made by Freepik from www.flaticon.com
+### Installation + +```bash +$ npm install --save @kibibit/kb-hologram +``` + +### Usage + +```javascript +import { SvgMaker, SvgMakerResultType } from '@kibibit/kb-hologram'; + +const svgMaker = new SvgMaker({ + 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 svgMaker + .render(SvgMakerResultType.PngBuffer); +``` + +### 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> + +
Module Icon made by Freepik from www.flaticon.com
From d48beed6521766d18c0347d9d5f5dc7db227717f Mon Sep 17 00:00:00 2001 From: thatkookooguy Date: Wed, 25 Dec 2019 22:03:09 +0200 Subject: [PATCH 2/3] fix(package): fix repo to point to correct github repo --- package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index fb2b166..14d8603 100644 --- a/package.json +++ b/package.json @@ -26,14 +26,14 @@ }, "repository": { "type": "git", - "url": "https://github.com/Kibibit/project-template.git" + "url": "https://github.com/Kibibit/kb-hologram.git" }, "author": "", "license": "ISC", "bugs": { - "url": "https://github.com/Kibibit/project-template/issues" + "url": "https://github.com/Kibibit/kb-hologram/issues" }, - "homepage": "https://github.com/Kibibit/project-template#readme", + "homepage": "https://github.com/Kibibit/kb-hologram#readme", "dependencies": { "class-transformer": "^0.2.3", "class-validator": "^0.11.0", From 374cd0ea5e2747066601502bbfd0f659849a50de Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Wed, 25 Dec 2019 20:11:54 +0000 Subject: [PATCH 3/3] chore(release): 1.0.0-next.1 [skip ci] # 1.0.0-next.1 (2019-12-25) ### Bug Fixes * **dependencies:** update packate-lock.json ([3748c28](https://github.com/Kibibit/kb-hologram/commit/3748c288205650f210dc2bce014d85ce191ea320)) * **package:** fix repo to point to correct github repo ([d48beed](https://github.com/Kibibit/kb-hologram/commit/d48beed6521766d18c0347d9d5f5dc7db227717f)) * **readme:** add readme text ([acfd2c9](https://github.com/Kibibit/kb-hologram/commit/acfd2c941b671815860347c82bcd0a8b6227a131)) * **templates:** add missing font loading to changelog template ([1d34eeb](https://github.com/Kibibit/kb-hologram/commit/1d34eeb8c4140669172740b159245fd26da1644d)) * **templates:** force -webkit-font-smoothing: antialiased ([c00cbd9](https://github.com/Kibibit/kb-hologram/commit/c00cbd9a663c735566ad915677a9a906f4ed98c0)) ### Features * **eng:** final touches before first version ([a32a1aa](https://github.com/Kibibit/kb-hologram/commit/a32a1aa10a7f6d51e6a3520a837c9d7b765d2759)) * **image-maker:** initial implementation ([6c1c6fe](https://github.com/Kibibit/kb-hologram/commit/6c1c6fe5cb7f7721cb02d570bcaa182987a1bdd1)) * **readme:** start working on readme, selecting icon, etc ([e05e891](https://github.com/Kibibit/kb-hologram/commit/e05e8910ebc32f27b3a481ed6dc28e0d2294db48)) * **templates:** make template sizes change based on viewport ([e83ea43](https://github.com/Kibibit/kb-hologram/commit/e83ea439c6069904c3447ea759b6b8f326487b83)) --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 14d8603..f5a64ce 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@kibibit/kb-hologram", - "version": "0.0.0-development", + "version": "1.0.0-next.1", "description": "create images from templates and data", "types": "lib/image-maker.d.ts", "main": "lib/image-maker.js",