From a0b5994a52601416447e22be27f9d3a5cbdb0507 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 31 Jan 2024 13:39:31 +0000 Subject: [PATCH] Auto-generated commit --- .github/.keepalive | 1 - .github/workflows/productionize.yml | 2 +- NOTICE | 2 +- README.md | 11 ++++++++--- branches.md | 9 ++++++--- docs/types/index.d.ts | 14 +++++++------- 6 files changed, 23 insertions(+), 16 deletions(-) delete mode 100644 .github/.keepalive diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0a5885c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T05:56:31.609Z diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml index 96d504a..9f701e2 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 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 cc388ad..00ab6ee 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,15 @@ npm install @stdlib/random-streams-uniform 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. +
@@ -647,8 +649,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/random-streams-uniform/tree/deno +[deno-readme]: https://github.com/stdlib-js/random-streams-uniform/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/random-streams-uniform/tree/umd +[umd-readme]: https://github.com/stdlib-js/random-streams-uniform/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/random-streams-uniform/tree/esm +[esm-readme]: https://github.com/stdlib-js/random-streams-uniform/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/random-streams-uniform/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-streams-uniform/main/LICENSE diff --git a/branches.md b/branches.md index 7a7bf0a..a18fa60 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/random/streams/uniform [production-url]: https://github.com/stdlib-js/random-streams-uniform/tree/production [deno-url]: https://github.com/stdlib-js/random-streams-uniform/tree/deno +[deno-readme]: https://github.com/stdlib-js/random-streams-uniform/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/random-streams-uniform/tree/umd +[umd-readme]: https://github.com/stdlib-js/random-streams-uniform/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/random-streams-uniform/tree/esm +[esm-readme]: https://github.com/stdlib-js/random-streams-uniform/blob/esm/README.md [cli-url]: https://github.com/stdlib-js/random-streams-uniform/tree/cli \ No newline at end of file diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 958f59b..5b71bd5 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -95,7 +95,7 @@ declare class RandomStream extends Readable { * @returns stream instance * * @example - * var inspectStream = require( `@stdlib/streams/node/inspect-sink` ); + * var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); * * function log( chunk ) { * console.log( chunk.toString() ); @@ -215,7 +215,7 @@ interface Constructor { * @returns stream instance * * @example - * var inspectStream = require( `@stdlib/streams/node/inspect-sink` ); + * var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); * * function log( chunk ) { * console.log( chunk.toString() ); @@ -243,7 +243,7 @@ interface Constructor { * @returns stream instance * * @example - * var inspectStream = require( `@stdlib/streams/node/inspect-sink` ); + * var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); * * function log( chunk ) { * console.log( chunk.toString() ); @@ -323,7 +323,7 @@ interface Constructor { * @returns stream instance * * @example - * var inspectStream = require( `@stdlib/streams/node/inspect-sink` ); + * var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); * * function log( v ) { * console.log( v ); @@ -352,7 +352,7 @@ interface Constructor { * @returns stream instance * * @example -* var inspectStream = require( `@stdlib/streams/node/inspect-sink` ); +* var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); * * function log( chunk ) { * console.log( chunk.toString() ); @@ -367,7 +367,7 @@ interface Constructor { * stream.pipe( inspectStream( log ) ); * * @example -* var inspectStream = require( `@stdlib/streams/node/inspect-sink` ); +* var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); * * function log( chunk ) { * console.log( chunk.toString() ); @@ -383,7 +383,7 @@ interface Constructor { * stream.pipe( inspectStream( log ) ); * * @example -* var inspectStream = require( `@stdlib/streams/node/inspect-sink` ); +* var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); * * function log( v ) { * console.log( v );