Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Feb 1, 2024
1 parent 65b1847 commit 86dcd9a
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/.keepalive
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-01-01T03:02:48.190Z
2024-02-01T03:40:01.040Z
3 changes: 2 additions & 1 deletion .github/workflows/productionize.yml
Original file line number Diff line number Diff line change
Expand Up @@ -772,7 +772,7 @@ jobs:
run: |
mkdir -p cli
mkdir -p cli/docs cli/test
cp README.md LICENSE CONTRIBUTORS NOTICE ./cli
cp README.md LICENSE CONTRIBUTORS NOTICE .npmignore ./cli
cp -r bin etc ./cli
if [ -e "test/test.cli.js" ]; then
cp test/test.cli.js ./cli/test
Expand Down Expand Up @@ -870,6 +870,7 @@ jobs:
# Move cli directory to root:
- name: 'Move cli directory to root'
run: |
mv ./cli/.npmignore .
mv ./cli/* .
rmdir ./cli
Expand Down
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Copyright (c) 2016-2023 The Stdlib Authors.
Copyright (c) 2016-2024 The Stdlib Authors.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,15 @@ npm install @stdlib/datasets-cmudict

Alternatively,

- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm` branch][esm-url].
- If you are using Deno, visit the [`deno` branch][deno-url].
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

</section>

<section class="usage">
Expand Down Expand Up @@ -356,8 +358,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/datasets-cmudict/tree/deno
[deno-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/datasets-cmudict/tree/umd
[umd-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/datasets-cmudict/tree/esm
[esm-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/datasets-cmudict/blob/main/branches.md

[cmudict]: http://www.speech.cs.cmu.edu/cgi-bin/cmudict#about
Expand Down
9 changes: 6 additions & 3 deletions branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ This repository has the following branches:

- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network).
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
- **deno**: [Deno][deno-url] branch for use in Deno.
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
- **cli**: [CLI][cli-url] branch for use on the command line.

The following diagram illustrates the relationships among the above branches:
Expand All @@ -52,6 +52,9 @@ C -->|extract| G[cli];
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets/cmudict
[production-url]: https://github.com/stdlib-js/datasets-cmudict/tree/production
[deno-url]: https://github.com/stdlib-js/datasets-cmudict/tree/deno
[deno-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/datasets-cmudict/tree/umd
[umd-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/datasets-cmudict/tree/esm
[esm-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/esm/README.md
[cli-url]: https://github.com/stdlib-js/datasets-cmudict/tree/cli

0 comments on commit 86dcd9a

Please sign in to comment.