From b2ecb98ec6179696ab4ab4db0fdf5833fcad2865 Mon Sep 17 00:00:00 2001
From: Andras Schmelczer <andras@schmelczer.dev>
Date: Sat, 4 Jan 2025 10:34:24 +0000
Subject: [PATCH] Add sync_lib crate docs

---
 backend/sync_lib/src/lib.rs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/backend/sync_lib/src/lib.rs b/backend/sync_lib/src/lib.rs
index 2258dee..2f3ec66 100644
--- a/backend/sync_lib/src/lib.rs
+++ b/backend/sync_lib/src/lib.rs
@@ -1,3 +1,13 @@
+//! This crate provides utilities for easily communicating between backend &
+//! frontend and ensuring the same logic for encoding and decoding binary data,
+//! and 3-way-merging documents in Rust and JavaScript.
+//!
+//! The crate is designed to be used as a Rust library and as a
+//! TypeScript/JavaScript package through WebAssembly (WASM).
+//!
+//! # Modules
+//!
+//! - `errors`: Contains error types used in this crate.
 use core::str;
 
 use base64::{engine::general_purpose::STANDARD_NO_PAD, Engine as _};