update README, add license

Signed-off-by: Shan He <[email protected]>

Author: heshan0131

.github/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[Bug]'
+labels: bug
+assignees: demartsc
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Mac or Windows]
+ - Platform: [Tableau Desktop or Server]
+ - Tableau Version [e.g. 2019.1.2]
+
+**Additional context**
+Add any other context about the problem here.

.github/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for kepler.gl
+title: ''
+labels: ''
+assignees: heshan0131
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -1,21 +1,46 @@
 # Kepler.gl Tableau
 
 ## Introduction
-This is the kepler.gl tableau extension. It will load a kepler.gl map visualization inside your Tableau Desktop App.
 
-## Links
-- [kepler.gl](http://kepler.gl)
-- [Tableau Extensions API](https://tableau.github.io/extensions-api/#)
+![kepler.gl for Tableau](./docs/kepler.gl-tableau.gif)
 
-This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
+This is the kepler.gl tableau extension. It will load a kepler.gl map visualization inside your Tableau Desktop App. You can use the same UI as in the kepler.lg demo app to interact with your map. The map can also be set up to communicate with your other Tableau charts.
+
+Due to the required WebGL support. This extension is supported on **Tableau Desktop (Mac Only) 2018.3** or **>= 2019.1.2** and **Tableau Server**.
+
+## Env Requirements
+Tableau Desktop (Mac Only) 2018.3 or >= 2019.1.2 and Tableau Server
+
+## Quick Start
+#### Step 1: Locate kepler.gl on the extension Gallery
+
+#### Step 2: Click ‘Allow’ to permit the extension to run.
+
+![Tableau Dashboard 3](./docs/Picture3.png)
+
+#### Step 3: Custom configurations
+Select sheet to plot, setup your own mapbox access token (optional) and how to do you want Tableau dashboard to communicate with your kepler.gl map. **kepler.gl is a client-side app. Your data stays in your Tableau application.**
 
-## Local Development
-Install [node](https://nodejs.org/en/download/package-manager/) (`> 6`), [yarn](https://yarnpkg.com/en/docs/install).
+![Tableau Dashboard 4](./docs/Picture4.png)
 
-Use Node v6 and above, older node versions have not been tested.
-For best management of Node versions, use [nvm](https://github.com/creationix/nvm) `nvm install`.
+#### Step 4: Interact with your map in kepler.gl.
+
+![Tableau Dashboard 5](./docs/Picture5.gif)
+
+#### Step 5: Save and reload
+No action is needed to save your map. kepler.gl will automatically save it to your Tableau session.
+
+#### Step 6: Submit Feedback and Help us Test!
+
+## Local Development Setup
+For a development installation (requires npm, node and yarn):
+
+Install [node](https://nodejs.org/en/download/package-manager/) (`> 8.15.0`), [yarn](https://yarnpkg.com/en/docs/install). For best management of Node versions, use [nvm](https://github.com/creationix/nvm)
+then simply run `nvm use 8`.
+
+This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
 
-### Start Node app
+### Start local app
 ##### 1. Clone repo
 ```sh
 git clone [email protected]:uber/kepler.gl-tableau.git
@@ -52,7 +77,7 @@ A debug session will be available in browser http://localhost:8696
 
 - Drag the extension onto view and select the trex file from your my tableau repository\extensions folder.
 
-- More information on Tableau Extension API about [Get Started with Dashboard Extensions
+- More information on [Tableau Extensions API](https://tableau.github.io/extensions-api/#) about [Get Started with Dashboard Extensions
 ](https://tableau.github.io/extensions-api/docs/trex_getstarted.html)
 
 ### Deploy

docs/Picture5.gif

@@ -16,16 +16,18 @@ Tableau Desktop (Mac Only) 2018.3 or >= 2019.1.2 and Tableau Server
 
 #### Step 3: Custom configurations
 
-The configuration capabilities of the extension will change over time, however, you will be able to set multiple configurations on your way into [kepler.gl](https://kepler.gl/) within Tableau. Each of these options also has a help description in the ? attached to each title. This content should explain what the purpose of the configuration is. If this is unclear to you during your use it would be great for us to know that we need to provide more guidance in this configuration screen. 
+The configuration capabilities of the extension will change over time, however, you will be able to set multiple configurations on your way into [kepler.gl](https://kepler.gl/) within Tableau. Each of these options also has a help description in the `?` attached to each title. This content should explain what the purpose of the configuration is. If this is unclear to you during your use it would be great for us to know that we need to provide more guidance in this configuration screen.
 
 ![Tableau Dashboard 4](Picture4.png)
 
 #### Step 4: Using [kepler.gl](https://kepler.gl/) within Tableau
 
-At this point you can use [kepler.gl](https://kepler.gl/) as you normally would. If you need additional detail on how to use [kepler.gl](https://kepler.gl/) to begin with, please visit the kepler.gl demo and guidance documentation at https://kepler.gl/. 
+At this point you can use [kepler.gl](https://kepler.gl/) as you normally would. If you need additional detail on how to use [kepler.gl](https://kepler.gl/) to begin with, please visit the kepler.gl demo and guidance documentation at https://kepler.gl/.
 
+#### Step 5: Save and reload
+No action is needed to save your map. kepler.gl will automatically save it to your Tableau session.
 
-#### Step 5: Submit Feedback and Help us Test!
+#### Step 6: Submit Feedback and Help us Test!
 
 For feedback/ feature requests, please let us know through the [kepler.gl Slack Channel](https://github.com/keplergl/kepler.gl/issues/643). We also encourage you to share your maps here to the rest of the map enthusiasts in the room too.
 

docs/README.md

@@ -1,8 +1,31 @@
 {
   "name": "kepler.gl-tableau",
+  "authors": [
+    "Chris DeMartini <[email protected]>",
+    "Shan He <[email protected]>"
+  ],
   "version": "0.1.0",
-  "homepage": "https://uber.github.io/kepler.gl-tableau",
-  "private": true,
+  "description": "kepler.gl is a webgl based application to visualize large scale location data in the browser",
+  "homepage": "https://github.com/keplergl/kepler.gl-tableau",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "engines": {
+    "node": ">=8.15.0",
+    "npm": ">=6.1.0",
+    "yarn": ">=1.6.0"
+  },
+  "keywords": [
+    "babel",
+    "es6",
+    "react",
+    "webgl",
+    "visualization",
+    "kepler.gl"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/keplergl/kepler.gl-tableau"
+  },
   "dependencies": {
     "@atlaskit/css-reset": "^3.0.2",
     "@material-ui/core": "^1.0.0",
@@ -33,13 +56,14 @@
     "eslint-config-uber-jsx": "^3.3.3",
     "eslint-plugin-babel": "^5.3.0",
     "eslint-plugin-prettier": "^3.0.1",
-    "eslint-plugin-react": "~7.12.4"
+    "eslint-plugin-react": "~7.12.4",
+    "uber-licence": "^3.1.1"
   },
   "scripts": {
     "predeploy": "npm run build",
     "deploy": "gh-pages -d build",
     "start": "react-scripts start",
-    "build": "react-scripts build",
+    "build": "uber-licence && react-scripts build",
     "test": "react-scripts test --env=jsdom",
     "eject": "react-scripts eject"
   },

docs/kepler.gl-tableau.gif

@@ -1,3 +1,23 @@
+// Copyright (c) 2019 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
 /* eslint-disable complexity */
 import React, {Component} from 'react';
 import {connect} from 'react-redux';

package.json

@@ -1,3 +1,23 @@
+// Copyright (c) 2019 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
 import React, {Component} from 'react';
 import App from './App';
 import parse from 'url-parse';

src/App.js

@@ -1,3 +1,23 @@
+// Copyright (c) 2019 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
 const tableauExt = window.tableau.extensions;
 
 let EnvName = "DEFAULT";