From 9fad9ad70e8e46e6ff8cdd3878a1b9c7b335dc24 Mon Sep 17 00:00:00 2001
From: Vaibhav Rabber <vrongmeal@gmail.com>
Date: Fri, 20 Dec 2024 01:08:46 +0530
Subject: [PATCH] docs: Crate level documentation (#124)

Signed-off-by: Vaibhav Rabber <vaibhav@s2.dev>
---
 src/lib.rs | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 74 insertions(+), 1 deletion(-)

diff --git a/src/lib.rs b/src/lib.rs
index 8bb9a73..b91c289 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,78 @@
-//! Rust SDK for S2.
+/*!
+Rust SDK for S2.
 
+The Rust SDK provides ergonomic wrappers and utilities to interact with the
+[S2 API](https://s2.dev/docs/interface/grpc-api).
+
+# Getting started
+
+1. Ensure you have `tokio` added as a dependency. The SDK relies on [Tokio](https://crates.io/crates/tokio)
+   for executing async code.
+
+   ```bash
+   cargo add tokio --features full
+   ```
+
+1. Add the `streamstore` dependency to your project:
+
+   ```bash
+   cargo add streamstore
+   ```
+
+1. Generate an authentication token by logging onto the web console at [s2.dev](https://s2.dev/dashboard).
+
+1. Make a request using SDK client.
+
+   ```no_run
+   # let _ = async move {
+   let config = s2::ClientConfig::new("<YOUR AUTH TOKEN>");
+   let client = s2::Client::new(config);
+
+   let basins = client.list_basins(Default::default()).await?;
+   println!("My basins: {:?}", basins);
+   # return Ok::<(), s2::client::ClientError>(()); };
+   ```
+
+See documentation for the [`client`] module for more information on how to
+use the client, and what requests can be made.
+
+# Examples
+
+We have curated a bunch of examples in the
+[SDK repository](https://github.com/s2-streamstore/s2-sdk-rust/tree/main/examples)
+demonstrating how to use the SDK effectively:
+
+* [List all basins](https://github.com/s2-streamstore/s2-sdk-rust/blob/main/examples/list_all_basins.rs)
+* [Explicit stream trimming](https://github.com/s2-streamstore/s2-sdk-rust/blob/main/examples/explicit_trim.rs)
+* [Producer (with concurrency control)](https://github.com/s2-streamstore/s2-sdk-rust/blob/main/examples/producer.rs)
+* [Consumer](https://github.com/s2-streamstore/s2-sdk-rust/blob/main/examples/consumer.rs)
+* and many more...
+
+This documentation is generated using
+[`rustdoc-scrape-examples`](https://doc.rust-lang.org/rustdoc/scraped-examples.html),
+so you will be able to see snippets from examples right here in the
+documentation.
+
+# Feedback
+
+We use [Github Issues](https://github.com/s2-streamstore/s2-sdk-rust/issues)
+to track feature requests and issues with the SDK. If you wish to provide
+feedback, report a bug or request a feature, feel free to open a Github
+issue.
+
+# Quick Links
+
+* [S2 Website](https://s2.dev)
+* [S2 Documentation](https://s2.dev/docs)
+* [CHANGELOG](https://github.com/s2-streamstore/s2-sdk-rust/blob/main/CHANGELOG.md)
+*/
+
+#![doc(
+    html_favicon_url = "https://raw.githubusercontent.com/s2-streamstore/s2-sdk-rust/main/assets/s2-black.png"
+)]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/s2-streamstore/s2-sdk-rust/main/assets/s2-black.png"
+)]
 #![warn(missing_docs)]
 
 #[rustfmt::skip]