codemp-proto/README.md

[![codemp](https://codemp.dev/static/banner.png)](https://codemp.dev)

> `codemp` is a **collaborative** text editing solution to work remotely.

It seamlessly integrates in your editor providing remote cursors and instant text synchronization,
as well as a remote virtual workspace for you and your team.

# Protocol
gRPC protocol specification for [`codemp`](https://github.com/hexedtech/codemp).

This is a [`prost`](https://github.com/tokio-rs/prost) crate: it will generated Rust code based on the protobuf defintions contained in the `proto/` directory.

From protobuf definition, `prost` will compile structs for all protocol messages but also server and client service implementations.

## Building
To compile this crate, `protoc` must be installed: [`prost` requires it to compile the protocol definition](https://docs.rs/prost/latest/prost/#protoc).
docs: update readme 2024-09-05 06:24:19 +02:00			`[![codemp](https://codemp.dev/static/banner.png)](https://codemp.dev)`

			> `codemp` is a collaborative text editing solution to work remotely.

			`It seamlessly integrates in your editor providing remote cursors and instant text synchronization,`
			`as well as a remote virtual workspace for you and your team.`
docs: written docs Co-authored-by: alemi <me@alemi.dev> 2024-09-05 00:08:07 +02:00
			`# Protocol`
docs: fixed readme formatting 2024-09-05 00:24:39 +02:00			gRPC protocol specification for [`codemp`](https://github.com/hexedtech/codemp).
docs: written docs Co-authored-by: alemi <me@alemi.dev> 2024-09-05 00:08:07 +02:00
docs: fixed readme formatting 2024-09-05 00:24:39 +02:00			This is a [`prost`](https://github.com/tokio-rs/prost) crate: it will generated Rust code based on the protobuf defintions contained in the `proto/` directory.
docs: written docs Co-authored-by: alemi <me@alemi.dev> 2024-09-05 00:08:07 +02:00
			From protobuf definition, `prost` will compile structs for all protocol messages but also server and client service implementations.

			`## Building`
			To compile this crate, `protoc` must be installed: [`prost` requires it to compile the protocol definition](https://docs.rs/prost/latest/prost/#protoc).