cronstrue 2.3.0 → 2.4.0

package/README.md

@@ -99,17 +99,19 @@ An options object can be passed as the second parameter to `cronstrue.toString`.
 
 ## i18n
 
-To use the i18n support cRonstrue provides, you can either import all the supported locales at once (using `cronstrue/i18n`) or by importing individual locales (using `cronstrue/locales/[locale]`).  Then, when calling `toString` you pass in the name of the locale you want to use.  For example, for the es (Spanish) locale, you would use: `cronstrue.toString("* * * * *", { locale: "es" })`.
+To use the i18n support cRonstrue provides, you can either import all the supported locales at once (using `cronstrue/i18n`) or import individual locales (using `cronstrue/locales/[locale]`).  Then, when calling `toString` you pass in the name of the locale you want to use.  For example, for the es (Spanish) locale, you would use: `cronstrue.toString("* * * * *", { locale: "es" })`.
 
 ### All Locales
 
-You can import all locales at once with `cronstrue/i18n`.  This approach has the advantage of only having to load one module and having access to all supported locales.  The tradeoff with this approach is a larger module that will take longer to load, particularly when sending down to a browser.
+You can import all locales at once with `cronstrue/i18n`.  This approach has the advantage of only having to load one module and having access to all supported locales.  The tradeoff with this approach is a larger module (~130k, minified) that will take longer to load, particularly when sending down to a browser.
 
 ```js
-// Node
+// Node / CommonJS
 const cronstrue = require('cronstrue/i18n');
-// ESM
+
+// ESM / webpack / TypeScript
 import cronstrue from 'cronstrue/i18n';
+
 // Browser
 <script src="https://unpkg.com/cronstrue@latest/cronstrue-i18n.min.js" async></script>
 
@@ -119,17 +121,19 @@ cronstrue.toString("*/5 * * * *", { locale: "es" }); // => Cada 5 minutos
 
 ### Individual Locales
 
-You can also load the main cronstrue module and then load individual locale modules you want to have access to.  This works well when you have one or more locales you know you need access to and want to minimize load time, particularly when sending down to a browser.
+You can also load the main cronstrue module and then load individual locale modules you want to have access to.  This works well when you have one or more locales you know you need access to and want to minimize load time, particularly when sending down to a browser.  The main cronstrue module is about 42k (minified) and each locale is about 4k (minified) in size.
 
 ```js
-// Node
+// Node / CommonJS
 const cronstrue = require('cronstrue');
 require('cronstrue/locales/fr');
 require('cronstrue/locales/es');
-// ESM
+
+// ESM / webpack / TypeScript
 import cronstrue from 'cronstrue';
 import 'cronstrue/locales/fr';
 import 'cronstrue/locales/es';
+
 // Browser
 <script src="https://unpkg.com/cronstrue@latest/cronstrue.min.js" async></script>
 <script src="https://unpkg.com/cronstrue@latest/locales/fr.min.js" async></script>
@@ -147,7 +151,7 @@ This library does not do full validation of cron expressions and assumes the exp
 
 > Can cRonstrue output the next occurrence of the cron expression?
 
-No, cRonstrue does not support this.  It simply describes a cron expression.  You could use another library to get the next occurrence of a cron expression and then pass that expression into cRonstrue, to achieve this.
+No, cRonstrue does not support this.  This library simply describes a cron expression that is passed in.
 
 ### Supported Locales
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cronstrue",
   "title": "cRonstrue",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Convert cron expressions into human readable descriptions",
   "author": "Brady Holt",
   "license": "MIT",