Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stuqdog authored Oct 14, 2022
1 parent d5a8679 commit ba38468
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Viam Rust Utils
Utilities built in rust with use in various Viam SDKs and beyond

## (In)stability Notice

> **Warning**
> This is a beta release of the Viam Rust SDK. Stability is not guaranteed. Breaking changes are likely to occur, and occur often.

## Prerequisites

### Installing Rust for Mac and Unix-Like
Expand All @@ -23,7 +17,7 @@ Next run the following command `curl --proto '=https' --tlsv1.2 -sSf https://sh.
- `examples` A list of examples

## Getting Started
The logic in this library is meant for use with Viam's SDKs - Rust and otherwise - rather than as a standalone product. To learn more about using the logic contained here, see the [rust-sdk](https://www.github.com/viamrobots/viam-rust-sdk) or [python-sdk](https://www.github.com/viamrobots/viam-python-sdk).
The logic in this library is meant for use with Viam's SDKs - Rust and otherwise - rather than as a standalone product. To learn more about using the logic contained here, see the [rust-sdk](https://www.github.com/viamrobotics/viam-rust-sdk) or [python-sdk](https://www.github.com/viamrobotics/viam-python-sdk).
If you would like to verify that this code works, you can run one of the examples by navigation to the examples folder and run `cargo run --bin test-echo` (you will need to provide your own robot's credentials to do so, or see instructions below)

### Echo Streaming Example
Expand Down

0 comments on commit ba38468

Please sign in to comment.