diff --git a/Examples-Web/README.md b/Examples-Web/README.md index 5b7ef00..e8d5161 100644 --- a/Examples-Web/README.md +++ b/Examples-Web/README.md @@ -14,16 +14,13 @@ These examples are best viewed fullscreen. ### TouchFree Web Tooling Integration -Several examples use a bundled version of tooling while others reference the [TouchFreeWebTooling GitHub](https://github.com/ultraleap/TouchFreeWebTooling) as an npm package dependency. When integrating the tooling into your own project there are a couple of ways we recommend: +Several examples use a bundled version of tooling while others reference the [TouchFreeWebTooling GitHub](https://github.com/ultraleap/TouchFreeWebTooling) as an NPM package dependency. When integrating the tooling into your own project there are a couple of ways we recommend: -1. JS Bundle - - A single `TouchFree_Tooling.js` bundle file available as a [download on the Ultraleap website](https://developer.leapmotion.com/touchfree-tooling-for-web). - - Steps to add this to a website are shown in the [documentation site](https://docs.ultraleap.com/touchfree-user-manual/tooling-for-web.html#add-touchfree-tooling-in-one-minute). -2. Integrating with Git URL - - Use TouchFree Web Tooling as an NPM package retrieved from the [GitHub repository](https://github.com/ultraleap/TouchFreeWebTooling). See [npm install docs](https://docs.npmjs.com/cli/v9/commands/npm-install) for more details about installing from git url. -3. NPM Workspace with Git Submodule - - Create a root package.json in a project folder (above both the submodule and your project) and add your project’s package.json and TouchFree Web Tooling package.json as workspaces within. See the [official npm workspaces docs](https://docs.npmjs.com/cli/v9/using-npm/workspaces?v=true) for more details. - - NOTE: Webpack doesn't seem to work with this method +1. NPM + - TouchFree Web Tooling is hosted on the [NPM registry](https://npmjs.com/package/touchfree) and can be installed with `npm i touchfree` +2. JS Bundle + - A single `TouchFree_Tooling.js` bundle file available as a [download on the Ultraleap website](https://developer.leapmotion.com/touchfree-tooling-for-web). + - Steps to add this to a website are shown in the [documentation site](https://docs.ultraleap.com/touchfree-user-manual/tooling-for-web.html#add-touchfree-tooling-in-one-minute). ## Hover Buttons @@ -73,4 +70,4 @@ Recommended Interaction: AirPush This example demonstrates how to begin and end analytics sessions from TouchFree Web Tooling. This is an "opt in" feature and will only run when triggered via Web Tooling as part of an application. -The output of the analytics recording can be found in csv files in this location: `C:\ProgramData\Ultraleap\TouchFree\AnalyticsSessions` \ No newline at end of file +The output of the analytics recording can be found in csv files in this location: `C:\ProgramData\Ultraleap\TouchFree\AnalyticsSessions`