Skip to content

Commit f782980

Browse files
committed
[Release] v1.0.1
1 parent 7f6f78d commit f782980

File tree

4 files changed

+25
-19
lines changed

4 files changed

+25
-19
lines changed

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# v1.0.0 (May 15, 2020)
2-
* First Release.
1+
# v1.0.1 (May 16, 2020)
2+
* Docs: 🔑 Liquid variables
33

44
[![](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)
5+
6+
7+
# v1.0.0 (May 15, 2020)
8+
* First Release.

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# 🦌 Badge generator of shields.io from .all-shieldsrc dotfile
44

5-
[![](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)
5+
[![](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)
66

7-
> 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)
7+
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)
88

99
## 🎁 Support: Donate
1010
> 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 @@
1919
- 🚀 [How to use](#-installation)
2020
- 📚 [Documentation](#-documentation)
2121
- - 🧰 [Options](#-options-badges-array)
22+
- - 🔑 [Liquid Variables](#-liquid-variables)
2223
- - 🐶 [With Husky](#-work-with-husky)
2324
- 🔨 [Developer Mode](#-developer-mode)
2425
- 👨‍💻 [Contributing](#-contributing)
@@ -78,6 +79,10 @@
7879

7980
See folder `examples`, run with `node example.js`. Below is available a description of `options` values.
8081

82+
83+
## 🔑 Liquid variables
84+
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}}`
85+
8186
## 🐶 Work with Husky
8287
1. In your node project run: `npm install husky --save-dev` ([docs](https://www.npmjs.com/package/husky))
8388
2. You can use pre-commit hooks with husky:

package-lock.json

Lines changed: 11 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@ptkdev/all-shields-cli",
33
"description": "Tool to help automate your badges of shields.io from a dotfile for your markdown files. Inspired by all-contributors-cli",
4-
"version": "1.0.0",
4+
"version": "1.0.1",
55
"bin": {
66
"all-shields-generate": "cli/generate.js",
77
"all-badges-generate": "cli/generate.js",

0 commit comments

Comments
 (0)