Skip to content

Commit c2730a6

Browse files
committed
Auto-generated commit
1 parent 0076a3b commit c2730a6

File tree

5 files changed

+18
-9
lines changed

5 files changed

+18
-9
lines changed

.github/.keepalive

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-01-01T01:12:50.369Z
1+
2024-02-01T01:18:54.398Z

.github/workflows/productionize.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,7 @@ jobs:
772772
run: |
773773
mkdir -p cli
774774
mkdir -p cli/docs cli/test
775-
cp README.md LICENSE CONTRIBUTORS NOTICE ./cli
775+
cp README.md LICENSE CONTRIBUTORS NOTICE .npmignore ./cli
776776
cp -r bin etc ./cli
777777
if [ -e "test/test.cli.js" ]; then
778778
cp test/test.cli.js ./cli/test
@@ -870,6 +870,7 @@ jobs:
870870
# Move cli directory to root:
871871
- name: 'Move cli directory to root'
872872
run: |
873+
mv ./cli/.npmignore .
873874
mv ./cli/* .
874875
rmdir ./cli
875876

NOTICE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Copyright (c) 2016-2023 The Stdlib Authors.
1+
Copyright (c) 2016-2024 The Stdlib Authors.

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,15 @@ npm install @stdlib/string-startcase
5151

5252
Alternatively,
5353

54-
- 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].
55-
- If you are using Deno, visit the [`deno` branch][deno-url].
56-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
54+
- 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]).
55+
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
56+
- 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]).
5757
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
5858

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

61+
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.
62+
6163
</section>
6264

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

263265
[deno-url]: https://github.com/stdlib-js/string-startcase/tree/deno
266+
[deno-readme]: https://github.com/stdlib-js/string-startcase/blob/deno/README.md
264267
[umd-url]: https://github.com/stdlib-js/string-startcase/tree/umd
268+
[umd-readme]: https://github.com/stdlib-js/string-startcase/blob/umd/README.md
265269
[esm-url]: https://github.com/stdlib-js/string-startcase/tree/esm
270+
[esm-readme]: https://github.com/stdlib-js/string-startcase/blob/esm/README.md
266271
[branches-url]: https://github.com/stdlib-js/string-startcase/blob/main/branches.md
267272

268273
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-startcase/main/LICENSE

branches.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ This repository has the following branches:
2424

2525
- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
2626
- **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).
27-
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
28-
- **deno**: [Deno][deno-url] branch for use in Deno.
29-
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
27+
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
28+
- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
29+
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
3030
- **cli**: [CLI][cli-url] branch for use on the command line.
3131

3232
The following diagram illustrates the relationships among the above branches:
@@ -52,6 +52,9 @@ C -->|extract| G[cli];
5252
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/startcase
5353
[production-url]: https://github.com/stdlib-js/string-startcase/tree/production
5454
[deno-url]: https://github.com/stdlib-js/string-startcase/tree/deno
55+
[deno-readme]: https://github.com/stdlib-js/string-startcase/blob/deno/README.md
5556
[umd-url]: https://github.com/stdlib-js/string-startcase/tree/umd
57+
[umd-readme]: https://github.com/stdlib-js/string-startcase/blob/umd/README.md
5658
[esm-url]: https://github.com/stdlib-js/string-startcase/tree/esm
59+
[esm-readme]: https://github.com/stdlib-js/string-startcase/blob/esm/README.md
5760
[cli-url]: https://github.com/stdlib-js/string-startcase/tree/cli

0 commit comments

Comments
 (0)