Add browser support to docs and update umd link (cruise-automation#65)

simonclouds · Jan 22, 2019 · cd559fa · cd559fa
1 parent 6b0ff96
commit cd559fa
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 3 deletions.
diff --git a/docs/src/2.1.QuickStart.mdx b/docs/src/2.1.QuickStart.mdx
@@ -11,7 +11,7 @@ npm install --save regl-worldview
 If you're not using a module bundler or package manager we also have a global ("UMD") build hosted on the unpkg CDN. Simply add the following script tag to the bottom of your HTML file:
 
 ```html
-<script src="https://unpkg.com/regl-worldview/dist/regl-worldview.umd.min.js" />
+<script src="https://unpkg.com/regl-worldview/dist/index.umd.js" />
 ```
 
 Then try rendering the [basic example](#/docs/examples/basicexample).
diff --git a/docs/src/3.5.BrowserSupport.mdx b/docs/src/3.5.BrowserSupport.mdx
@@ -0,0 +1,10 @@
+# Browser Support
+
+Currently we support the following browsers/versions:
+
+- Chrome 71+
+- Firefox 64+
+- Desktop Safari 11+
+- Opera 57+
+
+Some unsupported browsers may require polyfills to work. We'll add more support in the future.
diff --git a/docs/src/routes.js b/docs/src/routes.js
@@ -13,6 +13,7 @@ import Worldview from "./3.1.Worldview.mdx";
 import Camera from "./3.2.Camera.mdx";
 import Command from "./3.3.Command.mdx";
 import Flow from "./3.4.FlowTypes.mdx";
+import BrowserSupport from "./3.5.BrowserSupport.mdx";
 import Arrows from "./4.1.Arrows.mdx";
 import Text from "./4.10.Text.mdx";
 import Triangles from "./4.11.Triangles.mdx";
@@ -46,6 +47,7 @@ export const componentList = {
   Text,
   Triangles,
   Flow,
+  BrowserSupport,
 };
 
 const ROUTE_CONFIG = [
@@ -56,7 +58,7 @@ const ROUTE_CONFIG = [
   },
   {
     name: "API",
-    subRouteNames: ["Worldview", "Camera", "Command", "Flow"],
+    subRouteNames: ["Worldview", "Camera", "Command", "Flow", "Browser Support"],
   },
   {
     name: "Commands",

diff --git a/packages/regl-worldview/README.md b/packages/regl-worldview/README.md
@@ -15,7 +15,7 @@ npm install --save regl-worldview
 If you’re not using a module bundler or package manager we also have a global (“UMD”) build hosted on the unpkg CDN. Simply add the following script tag to the bottom of your HTML file:
 
 ```html
-<script src="https://unpkg.com/regl-worldview/dist/regl-worldview.umd.min.js" />
+<script src="https://unpkg.com/regl-worldview/dist/index.umd.js" />
 ```
 
 Then try rendering the [basic example](https://cruise-automation.github.io/webviz/worldview/#/docs/examples/basicexample):