From abab9ca37458d690f69793c432c4d13e7bdf2812 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 01:20:56 +0000 Subject: [PATCH] Auto-generated commit --- .github/.keepalive | 2 +- .github/workflows/productionize.yml | 3 ++- NOTICE | 2 +- README.md | 11 ++++++++--- branches.md | 9 ++++++--- 5 files changed, 18 insertions(+), 9 deletions(-) diff --git a/.github/.keepalive b/.github/.keepalive index 2293ca8..6520811 100644 --- a/.github/.keepalive +++ b/.github/.keepalive @@ -1 +1 @@ -2024-01-01T01:14:22.250Z +2024-02-01T01:20:53.094Z diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml index 96d504a..303a99a 100644 --- a/.github/workflows/productionize.yml +++ b/.github/workflows/productionize.yml @@ -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 @@ -870,6 +870,7 @@ jobs: # Move cli directory to root: - name: 'Move cli directory to root' run: | + mv ./cli/.npmignore . mv ./cli/* . rmdir ./cli diff --git a/NOTICE b/NOTICE index f7aca1b..e6e7482 100644 --- a/NOTICE +++ b/NOTICE @@ -1 +1 @@ -Copyright (c) 2016-2023 The Stdlib Authors. +Copyright (c) 2016-2024 The Stdlib Authors. diff --git a/README.md b/README.md index 30e3b68..7873355 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,15 @@ npm install @stdlib/datasets-female-first-names-en 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. +
@@ -271,8 +273,11 @@ Copyright © 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-female-first-names-en/tree/deno +[deno-readme]: https://github.com/stdlib-js/datasets-female-first-names-en/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/datasets-female-first-names-en/tree/umd +[umd-readme]: https://github.com/stdlib-js/datasets-female-first-names-en/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/datasets-female-first-names-en/tree/esm +[esm-readme]: https://github.com/stdlib-js/datasets-female-first-names-en/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/datasets-female-first-names-en/blob/main/branches.md [pddl-1.0]: http://opendatacommons.org/licenses/pddl/1.0/ diff --git a/branches.md b/branches.md index 8d35a49..a222395 100644 --- a/branches.md +++ b/branches.md @@ -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: @@ -52,6 +52,9 @@ C -->|extract| G[cli]; [stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets/female-first-names-en [production-url]: https://github.com/stdlib-js/datasets-female-first-names-en/tree/production [deno-url]: https://github.com/stdlib-js/datasets-female-first-names-en/tree/deno +[deno-readme]: https://github.com/stdlib-js/datasets-female-first-names-en/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/datasets-female-first-names-en/tree/umd +[umd-readme]: https://github.com/stdlib-js/datasets-female-first-names-en/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/datasets-female-first-names-en/tree/esm +[esm-readme]: https://github.com/stdlib-js/datasets-female-first-names-en/blob/esm/README.md [cli-url]: https://github.com/stdlib-js/datasets-female-first-names-en/tree/cli \ No newline at end of file