Add documentation comments to main binary package
This commit is contained in:
parent
ca80e73285
commit
f5687abeab
1 changed files with 9 additions and 0 deletions
|
@ -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]
|
||||
|
|
Loading…
Reference in a new issue