From f5687abeabf0f35ced4a4e1eb863e5b837d2e95b Mon Sep 17 00:00:00 2001 From: Tobie Morgan Hitchcock Date: Tue, 10 May 2022 11:53:30 +0100 Subject: [PATCH] Add documentation comments to main binary package --- src/main.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/main.rs b/src/main.rs index 399a2e17..9aff77f5 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,3 +1,12 @@ +//! This binary is the web-platform server for [SurrealDB](https://surrealdb.com) the +//! ultimate cloud database for tomorrow's applications. SurrealDB is a scalable, +//! distributed, collaborative, document-graph database for the realtime web. +//! +//! This binary can be used to start a database server instance using an embedded +//! in-memory datastore, or an embedded datastore persisted to disk. In addition, it +//! can be used in distributed mode by connecting to a distributed [TiKV](https://tikv.org) +//! key-value store. + #![forbid(unsafe_code)] #[macro_use]