Skip to content

Commit

Permalink
Update deps
Browse files Browse the repository at this point in the history
  • Loading branch information
njooma committed Oct 11, 2024
1 parent 1449855 commit 17efa78
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
8 changes: 5 additions & 3 deletions examples/vanilla/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This example demonstrates how to connect to a robot. The example uses Vite + vanilla TypeScript and HTML.

> NOTE: This example does not work in Firefox. Please use Safari/Chrome/Chromium-based browser
## Usage

You must have a `.env` file in this directory with the following connection info which can be easily found in the TypeScript code sample for your machine.
Expand All @@ -15,7 +17,7 @@ VITE_API_KEY="<API_KEY>"
Installing will build the TypeScript SDK, then you can run the example using Vite.

```
cd examples/teleop-vanilla
cd examples/vanilla
npm install
npm run dev
```
Expand All @@ -26,5 +28,5 @@ Edit `src/main.ts` to change the robot logic being run. Edit `index.html` to cha

This example assumes that you are working inside the Viam TypeScript SDK repository. If you want to use this example as a base for your project, make the following changes:

* Remove the `preinstall: ...` line from `package.json`
* Install the SDK: `npm install @viamrobotics/sdk@latest`
- Remove the `preinstall: ...` line from `package.json`
- Install the SDK: `npm install @viamrobotics/sdk@latest`
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 17efa78

Please sign in to comment.