Skip to content

Commit bd2fe4c

Browse files
committed
Update README
1 parent dcde4e7 commit bd2fe4c

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

dist/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,16 @@ This directory contains packages exporting distributable files for use in browse
3838

3939
## Usage
4040

41+
First, install a distributable package. For example, to install the main [stdlib][stdlib] bundle
42+
43+
```bash
44+
$ npm install --save @stdlib/dist-flat
45+
```
46+
47+
To use a bundle in a webpage,
48+
4149
```html
42-
<script type="text/javascript" src="/path/to/@stdlib/dist-<pkg>/build/<bundle>.js"></script>
50+
<script type="text/javascript" src="/path/to/node_modules/@stdlib/dist-<pkg>/build/<bundle>.js"></script>
4351
```
4452

4553
where `dist-<pkg>` corresponds to the desired published distributable file package and `<bundle>` corresponds to the desired bundle. For example, to include the main un-minified bundle exposing a flat namespace
@@ -102,6 +110,8 @@ If no recognized module system is present, access bundle contents via the global
102110

103111
[browserify]: https://github.com/browserify/browserify
104112

113+
[stdlib]: https://github.com/stdlib-js/stdlib
114+
105115
[@stdlib/namespace]: https://github.com/stdlib-js/stdlib
106116

107117
</section>

0 commit comments

Comments
 (0)