cronstrue 1.125.0 → 2.1.0

package/README.md

@@ -99,23 +99,33 @@ An options object can be passed as the second parameter to `cronstrue.toString`.
 
 ## i18n
 
-To use the i18n support cRonstrue provides, you must use the packaged library that contains the locale translations.  Once you do this, you can pass the name of a supported locale as an option to  `cronstrue.toString()`.  For example, for the es (Spanish) locale, you would use: `cronstrue.toString("* * * * *", { locale: "es" });`.
+To use the i18n support cRonstrue provides, you can import a specific locale and then call `toString()`. For example, for the es (Spanish) locale:
 
-### Node
 ```js
-var cronstrue = require('cronstrue/i18n');
-cronstrue.toString("*/5 * * * *", { locale: "fr" });
+import cronstrue from 'cronstrue/locales/es';
+cronstrue.toString("*/5 * * * *");
 ```
+
 ### Browser
- The `cronstrue-i18n.min.js` file from the `/dist` folder in the npm package should be served to the browser.
+
+A locale file from the `/locales` folder in the npm package should be served to the browser.
 
 ```html
-<script src="cronstrue-i18n.min.js" type="text/javascript"></script>
+<script src="https://unpkg.com/cronstrue@latest/locales/es.min.js" async></script>
 <script>
-  cronstrue.toString("*/5 * * * *", { locale: "fr" });
+  cronstrue.toString("*/5 * * * *");
 </script>
 ```
 
+## All Locales
+
+Alternatively you can import all locales and then pass in the `locale` option:
+
+```js
+import cronstrue from 'cronstrue/i18n';
+cronstrue.toString("*/5 * * * *", { locale: "es" });
+```
+
 ## Frequently Asked Questions
 
 > The cron expression I am passing in is not valid and this library is giving strange output.  What should I do?