Skip to content

Commit 5589ce3

Browse files
committed
docs: Make readme fancy with some badges
1 parent ca1b6dc commit 5589ce3

File tree

3 files changed

+36
-9
lines changed

3 files changed

+36
-9
lines changed

.github/workflows/push.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,11 @@ jobs:
7878
id: semantic
7979
env:
8080
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
81+
82+
- name: Trigger "Release" workflow if new release was created
83+
uses: peter-evans/repository-dispatch@v1
84+
if: steps.semantic.outputs.new_release_published == 'true'
85+
with:
86+
token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
87+
event-type: trigger-release
88+
client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

.github/workflows/release.yaml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
name: Release
22

33
on:
4-
release:
5-
types: [published]
6-
branches:
7-
- master
4+
repository_dispatch:
5+
types: [trigger-release]
86

97
jobs:
108
build:
@@ -13,6 +11,17 @@ jobs:
1311
outputs:
1412
vsixPath: ${{ steps.vsixBuild.outputs.vsixPath }}
1513
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v2
16+
17+
- name: Setup Node.js
18+
uses: actions/setup-node@v1
19+
with:
20+
node-version: 14
21+
22+
- name: Install dependencies
23+
run: npm install
24+
1625
- name: Build VSIX extension file
1726
uses: HaaLeo/publish-vscode-extension@v0
1827
id: vsixBuild

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# Cron Helper
1+
![logo](https://raw.githubusercontent.com/tumido/cron-explained/master/docs/assets/icon_large.png)
2+
3+
# Cron Explained
4+
5+
[![](https://vsmarketplacebadge.apphb.com/version-short/tumido.cron-explained.svg)](https://marketplace.visualstudio.com/items?itemName=tumido.cron-explained)
6+
[![](https://img.shields.io/github/v/release/tumido/cron-explained)](https://github.com/tumido/cron-explained/releases)
7+
[![](https://img.shields.io/github/license/tumido/cron-explained)](https://github.com/tumido/cron-explained/blob/master/LICENSE)
8+
[![](https://github.com/tumido/cron-explained/workflows/Release/badge.svg)](https://github.com/tumido/cron-explained/actions?query=workflow%3ARelease)
9+
![Dependabot](https://badgen.net/dependabot/tumido/cron-explained?icon=dependabot)
210

311
Have you ever found the cron format confusing? Did you ever need to know what is the "real" schedule? Are you tired of copy pasting the `"2,3,4 */2 * * 4"` into other online tools? This extension might come handy to you.
412

@@ -26,10 +34,12 @@ Command allowing you add an inline comment with the explanation.
2634

2735
This extension contributes the following settings:
2836

29-
- `cron-explained.use24HourTimeFormat`: If true, descriptions will use a 24-hour clock. Defaults to `true`.
30-
- `cron-explained.verbose`: Whether to use a verbose description. Defaults to `true`.
31-
- `cron-explained.enableCodeLens`: When enabled, the transcript is shown as a code lens. Defaults to `false`.
32-
- `cron-explained.enableHover`: When enabled, the transcript is shown in a hover tooltip. Defaults to `true`.
37+
| Settings | Description | Default value |
38+
| ------------------------------------ | --------------------------------------------------------- | ------------- |
39+
| `cron-explained.use24HourTimeFormat` | If set, descriptions will use a 24-hour clock. | `true` |
40+
| `cron-explained.verbose` | Whether to use a verbose description. | `true` |
41+
| `cron-explained.enableCodeLens` | When enabled, the transcript is shown as a code lens. | `false` |
42+
| `cron-explained.enableHover` | When enabled, the transcript is shown in a hover tooltip. | `true` |
3343

3444
## Credit
3545

0 commit comments

Comments
 (0)