Skip to content

Commit 2e3d74f

Browse files
committed
Update copy and add note regarding embedded bundling
1 parent 7fdf2b5 commit 2e3d74f

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ which will expose the `stdlib` command. For example, to see available sub-comman
176176
$ stdlib help
177177
```
178178

179-
For distributable bundles for use in browser environments, see the [`dist`][stdlib-bundles] directory and associated [guide][stdlib-bundles].
179+
For distributable bundles for use in browser environments or as shared ("vendored") libraries in server environments, see the [`dist`][stdlib-bundles] directory and associated [guide][stdlib-bundles].
180180

181181
Otherwise, to install as a system library, follow the [download][stdlib-development], [configuration][stdlib-development], and [installation][stdlib-development] instructions as described in the [development guide][stdlib-development].
182182

dist/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ limitations under the License.
2626

2727
<section class="intro">
2828

29-
This directory contains distributable files for use in browser environments. Each distributable is a standalone [UMD][umd] bundle which, if no recognized module system is present, will expose bundle contents to the global scope.
29+
This directory contains distributable files for use in browser environments or as shared ("vendored") libraries in server environments. Each distributable is a standalone [UMD][umd] bundle which, if no recognized module system is present, will expose bundle contents to the global scope.
3030

3131
</section>
3232

@@ -80,6 +80,8 @@ If no recognized module system is present, access bundle contents via the global
8080

8181
Please be mindful that [unpkg][unpkg] is a free, best-effort service relying on donated infrastructure which does **not** provide **any** availability guarantees. Under **no** circumstances should you **abuse** or **misuse** the service. You have been **warned**.
8282

83+
- If you intend on embedding a standalone bundle **within** another bundle, you may need to rename `require` calls within the standalone bundle **before** bundling in order to maintain scoped module resolution. For example, if you plan on using [browserify][browserify] to generate a bundle containing embedded bundles, [browserify][browserify] plugins exist to "de-require" those bundles prior to bundling.
84+
8385
### Bundles
8486

8587
#### Main
@@ -363,6 +365,8 @@ The help bundle, `stdlib-flat-help`, contains help texts for packages exposed in
363365

364366
[unpkg]: https://unpkg.com/#/
365367

368+
[browserify]: https://github.com/browserify/browserify
369+
366370
[@stdlib/namespace]: https://github.com/stdlib-js/stdlib
367371

368372
[@stdlib/repl]: https://github.com/stdlib-js/stdlib

0 commit comments

Comments
 (0)