Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -1 +1 @@
-2024-01-01T02:41:22.829Z
+2024-02-01T03:13:51.914Z

NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

README.md

@@ -55,12 +55,14 @@ npm install @stdlib/utils-async-for-each
 
 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]).
 
 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">
@@ -434,8 +436,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/utils-async-for-each/tree/deno
+[deno-readme]: https://github.com/stdlib-js/utils-async-for-each/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/utils-async-for-each/tree/umd
+[umd-readme]: https://github.com/stdlib-js/utils-async-for-each/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/utils-async-for-each/tree/esm
+[esm-readme]: https://github.com/stdlib-js/utils-async-for-each/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/utils-async-for-each/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-async-for-each/main/LICENSE

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]).
 
 The following diagram illustrates the relationships among the above branches:
 
@@ -49,5 +49,8 @@ C -->|bundle| F[umd];
 [stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/async/for-each
 [production-url]: https://github.com/stdlib-js/utils-async-for-each/tree/production
 [deno-url]: https://github.com/stdlib-js/utils-async-for-each/tree/deno
+[deno-readme]: https://github.com/stdlib-js/utils-async-for-each/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/utils-async-for-each/tree/umd
-[esm-url]: https://github.com/stdlib-js/utils-async-for-each/tree/esm
+[umd-readme]: https://github.com/stdlib-js/utils-async-for-each/blob/umd/README.md
+[esm-url]: https://github.com/stdlib-js/utils-async-for-each/tree/esm
+[esm-readme]: https://github.com/stdlib-js/utils-async-for-each/blob/esm/README.md

docs/types/index.d.ts

@@ -135,7 +135,7 @@ interface ForEachAsync {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error ) {
 	*     if ( error ) {
@@ -186,7 +186,7 @@ interface ForEachAsync {
 	* @throws must provide valid options
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function done( error ) {
 	*     if ( error ) {
@@ -236,7 +236,7 @@ interface ForEachAsync {
 	* @returns function which invokes the provided function once for each element in a collection
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function read( file, next ) {
 	*     var opts = {
@@ -291,7 +291,7 @@ interface ForEachAsync {
 	* @returns function which invokes the provided function once for each element in a collection
 	*
 	* @example
-	* var readFile = require( `@stdlib/fs/read-file` );
+	* var readFile = require( '@stdlib/fs-read-file' );
 	*
 	* function read( file, next ) {
 	*     var opts = {
@@ -349,7 +349,7 @@ interface ForEachAsync {
 * @throws must provide valid options
 *
 * @example
-* var readFile = require( `@stdlib/fs/read-file` );
+* var readFile = require( '@stdlib/fs-read-file' );
 *
 * function done( error ) {
 *     if ( error ) {