diff --git a/README.md b/README.md new file mode 100644 index 000000000..172aea702 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# regl-worldview + +**Worldview** is a React library for rendering 2D and 3D scenes using [regl](https://github.com/regl-project/regl). + +Visit the [homepage](https://cruise-automation.github.io/webviz/worldview) to see more guides, examples and APIs. + +## Quick start + +Add regl-worldview to your React project: + +```bash +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 +