diff --git a/.github/.keepalive b/.github/.keepalive index 20e07d9..65939f8 100644 --- a/.github/.keepalive +++ b/.github/.keepalive @@ -1 +1 @@ -2024-01-01T03:12:23.427Z +2024-02-01T03:51:24.479Z 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 2e8cccd..c6917f7 100644 --- a/README.md +++ b/README.md @@ -51,12 +51,14 @@ npm install @stdlib/math-strided-special-smsktrunc 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. +
@@ -403,8 +405,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/math-strided-special-smsktrunc/tree/deno +[deno-readme]: https://github.com/stdlib-js/math-strided-special-smsktrunc/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/math-strided-special-smsktrunc/tree/umd +[umd-readme]: https://github.com/stdlib-js/math-strided-special-smsktrunc/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/math-strided-special-smsktrunc/tree/esm +[esm-readme]: https://github.com/stdlib-js/math-strided-special-smsktrunc/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/math-strided-special-smsktrunc/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-strided-special-smsktrunc/main/LICENSE diff --git a/branches.md b/branches.md index d862504..9814f76 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]). 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/math/strided/special/smsktrunc [production-url]: https://github.com/stdlib-js/math-strided-special-smsktrunc/tree/production [deno-url]: https://github.com/stdlib-js/math-strided-special-smsktrunc/tree/deno +[deno-readme]: https://github.com/stdlib-js/math-strided-special-smsktrunc/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/math-strided-special-smsktrunc/tree/umd -[esm-url]: https://github.com/stdlib-js/math-strided-special-smsktrunc/tree/esm \ No newline at end of file +[umd-readme]: https://github.com/stdlib-js/math-strided-special-smsktrunc/blob/umd/README.md +[esm-url]: https://github.com/stdlib-js/math-strided-special-smsktrunc/tree/esm +[esm-readme]: https://github.com/stdlib-js/math-strided-special-smsktrunc/blob/esm/README.md \ No newline at end of file diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 2bca817..6a2a370 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -35,8 +35,8 @@ interface Routine { * @returns `y` * * @example - * var Float32Array = require( `@stdlib/array/float32` ); - * var Uint8Array = require( `@stdlib/array/uint8` ); + * var Float32Array = require( '@stdlib/array-float32' ); + * var Uint8Array = require( '@stdlib/array-uint8' ); * * var x = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9 ] ); * var m = new Uint8Array( [ 0, 0, 1, 0, 1 ] ); @@ -63,8 +63,8 @@ interface Routine { * @returns `y` * * @example - * var Float32Array = require( `@stdlib/array/float32` ); - * var Uint8Array = require( `@stdlib/array/uint8` ); + * var Float32Array = require( '@stdlib/array-float32' ); + * var Uint8Array = require( '@stdlib/array-uint8' ); * * var x = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9 ] ); * var m = new Uint8Array( [ 0, 0, 1, 0, 1 ] ); @@ -89,8 +89,8 @@ interface Routine { * @returns `y` * * @example -* var Float32Array = require( `@stdlib/array/float32` ); -* var Uint8Array = require( `@stdlib/array/uint8` ); +* var Float32Array = require( '@stdlib/array-float32' ); +* var Uint8Array = require( '@stdlib/array-uint8' ); * * var x = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9 ] ); * var m = new Uint8Array( [ 0, 0, 1, 0, 1 ] ); @@ -100,8 +100,8 @@ interface Routine { * // y => [ 1.0, 2.0, 0.0, 4.0, 0.0 ] * * @example -* var Float32Array = require( `@stdlib/array/float32` ); -* var Uint8Array = require( `@stdlib/array/uint8` ); +* var Float32Array = require( '@stdlib/array-float32' ); +* var Uint8Array = require( '@stdlib/array-uint8' ); * * var x = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9 ] ); * var m = new Uint8Array( [ 0, 0, 1, 0, 1 ] );