Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates Post-NPM Publish #23

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Updates Post-NPM Publish #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions Examples-Web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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`
The output of the analytics recording can be found in csv files in this location: `C:\ProgramData\Ultraleap\TouchFree\AnalyticsSessions`