Skip to content

Commit 3b824b9

Browse files
committed
chore: rewrite to ReScript instead of bs
1 parent 74e2c0a commit 3b824b9

File tree

13 files changed

+444
-512
lines changed

13 files changed

+444
-512
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# bs-cron
1+
# rescript-cron
22

3-
[![NPM version](http://img.shields.io/npm/v/bs-cron.svg)](https://www.npmjs.org/package/bs-cron)
4-
[![Build Status](https://travis-ci.org/mikaello/bs-node-cron.svg?branch=master)](https://travis-ci.org/mikaello/bs-node-cron)
3+
[![NPM version](http://img.shields.io/npm/v/rescript-cron.svg)](https://www.npmjs.org/package/rescript-cron)
4+
[![Build Status](https://travis-ci.org/mikaello/rescript-node-cron.svg?branch=master)](https://travis-ci.org/mikaello/rescript-node-cron)
55

6-
Bindings for [node-cron](https://github.com/kelektiv/node-cron), a tool that allows you to execute _something_ on a schedule. This is typically done using the cron syntax:
6+
Bindings for [node-cron](https://github.com/kelektiv/node-cron), a tool that
7+
allows you to execute _something_ on a schedule. This is typically done using
8+
the cron syntax:
79

810
```
911
* * * * * *
@@ -17,26 +19,28 @@ Bindings for [node-cron](https://github.com/kelektiv/node-cron), a tool that all
1719
└───────────────────────── second (0 - 59, OPTIONAL)
1820
```
1921

20-
Learn more about the syntax at [crontab.guru](https://crontab.guru/) (NB it does not have the seconds parameter and months start at 1 (this lib has 0-indexed months)).
22+
Learn more about the syntax at [crontab.guru](https://crontab.guru/) (NB it does
23+
not have the seconds parameter and months start at 1 (this lib has 0-indexed
24+
months)).
2125

2226
## Getting started
2327

2428
```
25-
yarn add bs-cron
29+
yarn add rescript-cron
2630
```
2731

28-
Then add `bs-cron` as a dependency to `bsconfig.json`:
32+
Then add `rescript-cron` as a dependency to `bsconfig.json`:
2933

3034
```diff
3135
"bs-dependencies": [
32-
+ "bs-cron"
36+
+ "rescript-cron"
3337
]
3438
```
3539

3640
## Example
3741

3842
```reason
39-
open BsCron
43+
open RescriptCron
4044
4145
// Make a job that will fire every second when started
4246
let job =
@@ -59,15 +63,20 @@ setTime(job, time);
5963
start(job);
6064
```
6165

62-
[The tests](https://github.com/mikaello/bs-node-cron/tree/master/__tests__) have more examples of how to use these bindings.
63-
66+
[The tests](https://github.com/mikaello/rescript-node-cron/tree/master/__tests__)
67+
have more examples of how to use these bindings.
6468

6569
## Contribute
6670

67-
- If you find bugs or want to improve this library, feel free to open an issue or PR.
68-
- If you are upgrading any dependencies, please use yarn so `yarn.lock` is updated.
69-
- Try to adhere to [Angular commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guideline).
71+
- If you find bugs or want to improve this library, feel free to open an issue
72+
or PR.
73+
- If you are upgrading any dependencies, please use yarn so `yarn.lock` is
74+
updated.
75+
- Try to adhere to
76+
[Angular commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guideline).
7077

7178
## Alternatives
7279

73-
[_node-schedule_](https://github.com/node-schedule/node-schedule) is a JS library similar to [_node-cron_](https://github.com/kelektiv/node-cron) (which this library is bindings for).
80+
[_node-schedule_](https://github.com/node-schedule/node-schedule) is a JS
81+
library similar to [_node-cron_](https://github.com/kelektiv/node-cron) (which
82+
this library is bindings for).

__tests__/CronJob_tests.re

Lines changed: 0 additions & 213 deletions
This file was deleted.

0 commit comments

Comments
 (0)