diff --git a/README.md b/README.md index b689de3..049ae59 100755 --- a/README.md +++ b/README.md @@ -1,162 +1,113 @@ -# Tableau Extension Framework +# Annotate All The (Tableau)Things! +### Layering React Annotation on top of Tableau -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +## Introduction -## Creating a Tableau Extension via `create-tableau-extension` -The easiest way to create a new Tableau Extension is by using `create-tableau-extension` tool from NPM. +![React Annotation in Tableau Image](./docs/D1-Annotations.gif) -Installation: +This is the tableau extension that allows you to layer [Susie Lu's](https://twitter.com/datatoviz?lang=en) [react-annotation](https://react-annotation.susielu.com/) library on top of Tableau. When you add this to your dashboard (you will likely want to cover your entire dashboard with it) you can leverage the majority of annotation types and options available in [react-annotation](https://react-annotation.susielu.com/) directly within Tableau. We have built a simple configuration UI that you can take advantage of to be able annotate your viz to your heart's delight. -```sh -npm install -g create-tableau-extension -or -yarn global add create-tableau-extension -``` - -Then you simply run `create-tableau-extension` command from your work folder and an interactive terminal will guild you throw the process. - -## Available Scripts - -In the project directory, you can run: - -### `yarn install` - -Installs all the dependencies. +This extension is supported on **Tableau Desktop >=2018.3** and **Tableau Server**. It works best when deployed directly on to the Tableau Server you are using and the content of the extensions is also viewable on **Tableau Mobile**. -### `yarn start` +## Env Requirements +Tableau Desktop >= 2018.2 and Tableau Server >= 2018.2 -Make sure you have a correct name, description and version inside the `package.json` file. +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app) along with [StarSchema](https://starschema.com/) & [DataBlick's](https://www.datablick.com/) **Tableau Extension Framework**. -**Note!** If you try running this project after cloning it, you may have to remove the # from the name before the run. +## Quick Start +#### Step 1: Locate Annotate All The (Tableau) Things on the [Tableau Community Extensions](https://tableau.github.io/extensions-api/community/) page -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +Note: If you want the best experience, you should deploy a compiled version of this code directly to your Tableau Server and point your .trex file to that deployment of the extension. -The page will reload if you make edits.
-You will also see any lint errors in the console. +#### Step 2: Click ‘Allow’ to permit the extension to run. -### `yarn run build` +![Allow Extension in Desktop Image](./docs/Allow-extension.png) -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -## Configuration -The main entry point of customization is the `src/extension_assets` folder. - -### Creating a custom splash screen - -To create a custom splash screen (front screen of your extension) you have to modify the `src/extension_assets/splash/index.js` file. - -Note the `Button` component on the 29th row: -```js -