# volt-ws-protocol

This crate provides a Rust implementation of the Volt Websocket Protocol.

The library is used by the [`volt-client-rs`](../volt-client-rs/) library to communicate with the Volt API in Rust applications, by [`volt-ws-protocol-component`](../volt-ws-protocol-component/) to communicate with the Volt API via webassembly components (for example, using wasmtime from python applications), and by [`volt-ws-protocol-web`](../volt-ws-protocol-web/) to communicate with the Volt API via websockets in web applications.

## build

```sh
cargo build
```

## usage

It is unlikely that you will need to use this library directly, refer to the following projects:

- [`volt-client-rs`](../volt-client-rs/) for accessing the Volt API from Rust applications.
- [`volt-client-web`](https://github.com/tdxvolt/tdxvolt-js/tree/master/packages/volt-client-web) for accessing the Volt API from javascript web applications.
- [`volt-client-grpc`](https://github.com/tdxvolt/tdxvolt-js/tree/master/packages/volt-client-grpc) for accessing the Volt API from javascript nodejs applications using gRPC.
- [`volt_client_py`](https://github.com/tdxvolt/tdxvolt-py/tree/main/volt_client_web) for accessing the Volt API from python applications.