Skip to content

Commit 16a910b

Browse files
committed
Add note regarding unpkg
1 parent 9e646d2 commit 16a910b

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

dist/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,17 @@ If no recognized module system is present, access bundle contents via the global
4949
## Notes
5050

5151
- Bundles are one of two namespace types: `flat` or `tree`. A `tree` namespace is a nested object namespace which mirrors the project's layout (e.g., `stdlib.math.base.special.erf`. A `flat` namespace uses the global alias [namespace][@stdlib/namespace], where each package has a unique alias (e.g., `stdlib.base.erf`). Which namespace is preferred depends on personal taste and application context.
52+
5253
- Each minified bundle has a corresponding [gzip][gzip]-compressed bundle. The [gzip][gzip] compression level for each compressed bundle is `9`, which is the highest (and most optimal) compression level. Deciding between uncompressed and compressed bundles depends on the application and whether compression is handled elsewhere in the application stack (e.g., [nginx][nginx], [CDN][cdn], _et cetera_).
5354

55+
- While you are **strongly** encouraged to **vendor** bundles and host with a [CDN][cdn]/provider which can provide availability **guarantees**, especially for production applications, bundles are available via [unpkg][unpkg] for quick demos, proof-of-concepts, and instructional material. For example,
56+
57+
```html
58+
<script type="text/javascript" src="https://unpkg.com/@stdlib/stdlib/dist/stdlib-repl.min.js"></script>
59+
```
60+
61+
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**.
62+
5463
### Bundles
5564

5665
#### Main
@@ -157,6 +166,8 @@ The REPL bundle, `stdlib-repl`, contains all packages exposed via the project RE
157166

158167
[cdn]: https://en.wikipedia.org/wiki/Content_delivery_network
159168

169+
[unpkg]: https://unpkg.com/#/
170+
160171
[@stdlib/namespace]: https://github.com/stdlib-js/stdlib
161172

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

0 commit comments

Comments
 (0)