Add README

kgryte · kgryte · commit 9548e83a5e55 · 2017-09-25T02:40:51.000-07:00
diff --git a/dist/README.md b/dist/README.md
@@ -0,0 +1,64 @@
+# dist
+
+> Distributable files.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+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.
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Section to include usage notes. -->
+
+<section class="usage">
+
+## Usage
+
+```html
+<script type="text/javascript" src="/path/to/<bundle>.js"></script>
+```
+
+For example, to include the main un-minified bundle which exposes a flat namespace
+
+```html
+<script type="text/javascript" src="/path/to/stdlib-flat.js"></script>
+```
+
+If no recognized module system is present, access bundle contents via the global scope. For example, assuming a flat namespace,
+
+```html
+<script type="text/javascript">
+    var erf = stdlib.erf;
+    console.log( erf( 0.5 ) );
+</script>
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Section to include usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   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 project namespace, where each project package has a unique alias (e.g., `stdlib.base.erf`). Which namespace is preferred depends on personal taste and application context. 
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[umd]: https://github.com/umdjs/umd
+
+</section>
+
+<!-- /.links -->
