Skip to content

Commit 51d90b4

Browse files
authored
Update README.md (#227)
1 parent e14d8f5 commit 51d90b4

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

examples/teleop-react/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,24 @@ First, follow the setup instructions for the repository in `CONTRIBUTING.md`. Th
99
```shell
1010
cd examples/teleop-react
1111
npm install
12-
npm start
1312
```
1413

15-
The connection hostname and secret fields can be pre-filled from a `.env` file in the `teleop-react` directory.
14+
The connection hostname and secret fields can be pre-filled from a `.env` file in the `teleop-react` directory. You have to set these before running npm start.
1615

1716
```ini
1817
# examples/teleop-react/.env
1918
VITE_ROBOT_HOSTNAME=my-cool-robot.viam.cloud
2019
VITE_ROBOT_SECRET=super-secret-key
2120
```
2221

22+
```shell
23+
npm start
24+
```
25+
2326
### Base Project Template
2427

2528
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:
2629

2730
* Remove the `preinstall: ...` line from `package.json`
2831
* Install the SDK: `npm install --save @viamrobotics/sdk@latest`
32+
* You will also need to rename the components in the example code to match the actual component names in your configuration, for example, the camera could be named "cam" here but "camera" in your configuration.

0 commit comments

Comments
 (0)