Skip to content

Commit a057429

Browse files
authored
chore: improve npm package metadata and add README badges (#10)
Expand the package description and keywords for npm discoverability, and add CI, version, downloads, types, and license badges to the README.
1 parent 395b489 commit a057429

2 files changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# cron-translate
22

3+
[![CI](https://github.com/node-cron/cron-translate/actions/workflows/ci.yml/badge.svg)](https://github.com/node-cron/cron-translate/actions/workflows/ci.yml)
4+
[![npm version](https://img.shields.io/npm/v/cron-translate.svg)](https://www.npmjs.com/package/cron-translate)
5+
[![npm downloads](https://img.shields.io/npm/dm/cron-translate.svg)](https://www.npmjs.com/package/cron-translate)
6+
[![types](https://img.shields.io/npm/types/cron-translate.svg)](https://www.npmjs.com/package/cron-translate)
7+
[![license](https://img.shields.io/npm/l/cron-translate.svg)](https://www.npmjs.com/package/cron-translate)
8+
39
Translate plain English into cron expressions.
410

511
`cron-translate` turns the schedule you would describe out loud ("every weekday at

package.json

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "cron-translate",
33
"version": "2.0.0",
4-
"description": "Translates text to cron expression",
4+
"description": "Translate plain English into cron expressions. Zero-dependency, TypeScript-native, built for node-cron.",
55
"type": "module",
66
"main": "./dist/index.cjs",
77
"module": "./dist/index.js",
@@ -36,7 +36,18 @@
3636
},
3737
"keywords": [
3838
"cron",
39-
"translate"
39+
"crontab",
40+
"cron-expression",
41+
"cron-parser",
42+
"cron-generator",
43+
"cron-translate",
44+
"node-cron",
45+
"schedule",
46+
"scheduler",
47+
"scheduling",
48+
"natural-language",
49+
"english-to-cron",
50+
"recurring"
4051
],
4152
"author": "Lucas Merencia <lucas@merencia.com>",
4253
"license": "ISC",

0 commit comments

Comments
 (0)