From f78298099428f849b1d8bade792f16b0aa3e41ee Mon Sep 17 00:00:00 2001 From: "Patryk Rzucidlo (PTKDev)" Date: Sat, 16 May 2020 14:42:18 +0200 Subject: [PATCH] [Release] v1.0.1 --- CHANGELOG.md | 8 ++++++-- README.md | 9 +++++++-- package-lock.json | 25 +++++++++++-------------- package.json | 2 +- 4 files changed, 25 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b082cce..d859182 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,8 @@ -# v1.0.0 (May 15, 2020) -* First Release. +# v1.0.1 (May 16, 2020) +* Docs: 🔑 Liquid variables [![](https://img.shields.io/badge/donate-paypal-005EA6.svg?logo=paypal)](https://www.paypal.me/ptkdev) [![](https://img.shields.io/badge/donate-patreon-F87668.svg?logo=patreon)](https://www.patreon.com/ptkdev) [![](https://img.shields.io/badge/donate-sponsors-ea4aaa.svg?logo=github)](https://github.com/sponsors/ptkdev/) [![](https://img.shields.io/badge/donate-ko--fi-29abe0.svg?logo=ko-fi)](https://ko-fi.com/ptkdev) + + +# v1.0.0 (May 15, 2020) +* First Release. diff --git a/README.md b/README.md index f171e66..cc09a23 100755 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ # 🦌 Badge generator of shields.io from .all-shieldsrc dotfile -[![](https://img.shields.io/badge/version-v1.0.0-lightgrey.svg)](https://github.com/ptkdev/all-shields-cli/releases) [![](https://img.shields.io/npm/v/@ptkdev/all-shields-cli.svg)](https://www.npmjs.com/package/@ptkdev/all-shields-cli) [![](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/ptkdev/all-shields-cli/blob/master/LICENSE.md) [![](https://img.shields.io/badge/ES-9-F7DF1E.svg)](https://wikipedia.org/wiki/ECMAScript) [![](https://snyk.io/test/github/ptkdev/all-shields-cli/badge.svg)](https://snyk.io/test/github/ptkdev/all-shields-cli) [![](https://discordapp.com/api/guilds/383373985666301975/embed.png)](http://discord.ptkdev.io) +[![](https://img.shields.io/badge/version-v1.0.1-lightgrey.svg)](https://github.com/ptkdev/all-shields-cli/releases) [![](https://img.shields.io/npm/v/@ptkdev/all-shields-cli.svg)](https://www.npmjs.com/package/@ptkdev/all-shields-cli) [![](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/ptkdev/all-shields-cli/blob/master/LICENSE.md) [![](https://img.shields.io/badge/ES-9-F7DF1E.svg)](https://wikipedia.org/wiki/ECMAScript) [![](https://snyk.io/test/github/ptkdev/all-shields-cli/badge.svg)](https://snyk.io/test/github/ptkdev/all-shields-cli) [![](https://discordapp.com/api/guilds/383373985666301975/embed.png)](http://discord.ptkdev.io) -> Tool to help automate your badges of shields.io from a dotfile for your markdown files. You can use Liquid variables like `{{name}}` or `{{version}}` which refer to your `package.json`. Inspired by [all-contributors-cli](https://www.npmjs.com/package/all-contributors-cli) +Tool to help automate your badges of shields.io from a dotfile for your markdown files. You can use Liquid variables like `{{name}}` or `{{version}}` which refer to your `package.json`. Inspired by [all-contributors-cli](https://www.npmjs.com/package/all-contributors-cli) ## 🎁 Support: Donate > This project is **free**, **open source** and I try to provide excellent **free support**. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. **THANK YOU!** @@ -19,6 +19,7 @@ - 🚀 [How to use](#-installation) - 📚 [Documentation](#-documentation) - - 🧰 [Options](#-options-badges-array) +- - 🔑 [Liquid Variables](#-liquid-variables) - - 🐶 [With Husky](#-work-with-husky) - 🔨 [Developer Mode](#-developer-mode) - 👨‍💻 [Contributing](#-contributing) @@ -78,6 +79,10 @@ See folder `examples`, run with `node example.js`. Below is available a description of `options` values. + +## 🔑 Liquid variables +In your `.all-shieldsrc` dotfile you can use liquid variables like {{name}} or {{version}} which refer to your `package.json`. Key of `package.json` is name of liquid variable `{{key_from_package.json}}` + ## 🐶 Work with Husky 1. In your node project run: `npm install husky --save-dev` ([docs](https://www.npmjs.com/package/husky)) 2. You can use pre-commit hooks with husky: diff --git a/package-lock.json b/package-lock.json index cf79acc..6f878a3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@ptkdev/all-shields-cli", - "version": "1.0.0", + "version": "1.0.1", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -3529,9 +3529,9 @@ } }, "eslint-plugin-jest": { - "version": "23.11.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-23.11.0.tgz", - "integrity": "sha512-qedvh6mcMgoLFHjITtG40yKOCu5Fa1GMYesDOclU30ZvtVkf+DaH0fnCn1ysOX/QMdk2SGhQvxvYLowcLaM0GA==", + "version": "23.13.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-23.13.0.tgz", + "integrity": "sha512-AG18G0qFCgFOdhMibl4cTuKTCBVjzm/hEPYMOPCTj3Yh2GQ53q5u5Jj3a4nl1JH1BxqPsXIrZR1oRE+TdptfHw==", "dev": true, "requires": { "@typescript-eslint/experimental-utils": "^2.5.0" @@ -9317,9 +9317,9 @@ "dev": true }, "open": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/open/-/open-7.0.3.tgz", - "integrity": "sha512-sP2ru2v0P290WFfv49Ap8MF6PkzGNnGlAwHweB4WR4mr5d2d0woiCluUeJ218w7/+PmoBy9JmYgD5A4mLcWOFA==", + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/open/-/open-7.0.4.tgz", + "integrity": "sha512-brSA+/yq+b08Hsr4c8fsEW2CRzk1BmfN3SAK/5VCHQ9bdoZJ4qa/+AfR0xHjlbbZUyPkUHs1b8x1RqdyZdkVqQ==", "dev": true, "requires": { "is-docker": "^2.0.0", @@ -11153,13 +11153,10 @@ "dev": true }, "yaml": { - "version": "1.9.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.9.2.tgz", - "integrity": "sha512-HPT7cGGI0DuRcsO51qC1j9O16Dh1mZ2bnXwsi0jrSpsLz0WxOLSLXfkABVl6bZO629py3CU+OMJtpNHDLB97kg==", - "dev": true, - "requires": { - "@babel/runtime": "^7.9.2" - } + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.0.tgz", + "integrity": "sha512-yr2icI4glYaNG+KWONODapy2/jDdMSDnrONSjblABjD9B4Z5LgiircSt8m8sRZFNi08kG9Sm0uSHtEmP3zaEGg==", + "dev": true }, "yamljs": { "version": "0.3.0", diff --git a/package.json b/package.json index a6320b0..e40007c 100755 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@ptkdev/all-shields-cli", "description": "Tool to help automate your badges of shields.io from a dotfile for your markdown files. Inspired by all-contributors-cli", - "version": "1.0.0", + "version": "1.0.1", "bin": { "all-shields-generate": "cli/generate.js", "all-badges-generate": "cli/generate.js",