From 2622712dc5690930beafefe7110044a0eb22748a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20R=C3=A8gne?= Date: Thu, 18 May 2023 21:58:18 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20Am=C3=A9liorer=20le=20README.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 41194df..a3331ab 100644 --- a/README.md +++ b/README.md @@ -52,32 +52,39 @@ import Cron from "https://deno.land/x/cronnor/mod.js"; ### Navigateurs Elle est aussi accessible directement avec le CDN [jsDelivr][link-jsdelivr] (ou -[UNPKG](https://unpkg.com/cronnor/), [esm.sh](https://esm.sh/cronnor)) : +[UNPKG](https://unpkg.com/browse/cronnor/), [esm.sh](https://esm.sh/cronnor)) : ```JavaScript -import Cron from "https://cdn.jsdelivr.net/npm/cronnor@2/+esm"; +import Cron from "https://cdn.jsdelivr.net/npm/cronnor@2"; // import Cron from "https://unpkg.com/cronnor@2"; // import Cron from "https://esm.sh/cronnor@2"; ``` ## API -- [`new Cron(cronex, func, [options])`](#new-croncronex-func-options) +- [Cron](#cron) + - [`new Cron(cronex, func, [options])`](#new-croncronex-func-options) - [`Cron.active`](#cronactive) - [`Cron.run()`](#cronrun) - [`Cron.start()`](#cronstart) - [`Cron.stop()`](#cronstop) - [`Cron.test([date])`](#crontestdate) - [`Cron.next([start])`](#cronnextstart) -- [`new CronExp(pattern)`](#new-cronexppattern) +- [CronExp](#cronexp) + - [`new CronExp(pattern)`](#new-cronexppattern) - [`CronExp.test([date])`](#cronexptestdate) - [`CronExp.next([start])`](#cronexpnextstart) -- [`new At(date, func, [options])`](#new-atdate-func-options) +- [At](#at) + - [`new At(date, func, [options])`](#new-atdate-func-options) - [`At.run()`](#atrun) - [`At.abort()`](#atabort) ### Cron +```JavaScript +import Cron from "cronnor/cron"; +``` + #### `new Cron(cronex, func, [options])` Crée une tâche _cronée_. @@ -146,6 +153,10 @@ Calcule la prochaine date respectant une des expressions _cron_ de la tâche. ### CronExp +```JavaScript +import CronExp from "cronnor/cronexp"; +``` + #### `new CronExp(pattern)` Crée une expression _cron_. @@ -177,6 +188,10 @@ Calcule la prochaine date respectant l'expression. ### At +```JavaScript +import At from "cronnor/at"; +``` + #### `new At(date, func, [options])` Crée une tâche planifiée.