Skip to content

Update README.md #556

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #556

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
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,19 @@ To use this SDK with node, read the [documentation](https://github.com/viamrobot

To use this SDK with React Native, read the [documentation](https://github.com/viamrobotics/viam-typescript-sdk/blob/main/ReactNative.md) or view the [example](https://github.com/viamrobotics/viam-typescript-sdk/tree/main/examples/react-native/)

## Offline Mode

> [!WARNING]
> Using the typescript SDK in offline mode necessitates disabling TLS verification and so should be done with caution.

To use the browser on a local network with limited-or-no internet, follow these instructions:
```
1. start viam-server with the `-no-tls` flag
2. set the signaling server in typescript to `http://{HOST}.local:8080`
```

## License

Copyright 2022-2024 Viam Inc.
Copyright 2022-2025 Viam Inc.

Apache 2.0 - See [LICENSE](https://github.com/viamrobotics/viam-typescript-sdk/blob/main/LICENSE) file