From d4f11d47c9391382206e3552d96055c81afddaed Mon Sep 17 00:00:00 2001 From: Ethan Date: Tue, 6 May 2025 14:24:33 -0400 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ef85b3c3..af8e64a6c 100644 --- a/README.md +++ b/README.md @@ -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