Skip to content

Commit 6436edc

Browse files
committed
docs: add placeholder crate with README.md
1 parent ecfef40 commit 6436edc

File tree

6 files changed

+41
-2
lines changed

6 files changed

+41
-2
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/cluster/toydb*/data
22
/data
3+
/docs/crate/target
34
/target
45
.DS_Store
56
.vscode/
6-
**/*.rs.bk
7+
**/*.rs.bk

Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
[package]
22
name = "toydb"
33
version = "1.0.0"
4-
description = "A distributed SQL database"
4+
description = "A simple distributed SQL database, built for education"
55
authors = ["Erik Grinaker <[email protected]>"]
66
license = "Apache-2.0"
77
homepage = "https://github.com/erikgrinaker/toydb"
88
repository = "https://github.com/erikgrinaker/toydb"
99
edition = "2024"
1010
default-run = "toydb"
11+
publish = false
1112

1213
[lib]
1314
doctest = false

docs/crate/Cargo.lock

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/crate/Cargo.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[package]
2+
name = "toydb"
3+
version = "1.0.0"
4+
description = "A simple distributed SQL database, built for education"
5+
authors = ["Erik Grinaker <[email protected]>"]
6+
license = "Apache-2.0"
7+
homepage = "https://github.com/erikgrinaker/toydb"
8+
repository = "https://github.com/erikgrinaker/toydb"
9+
edition = "2024"

docs/crate/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# toyDB
2+
3+
toyDB is a distributed SQL database in Rust, built from scratch as an educational project. Main
4+
features:
5+
6+
* Raft distributed consensus for linearizable state machine replication.
7+
8+
* ACID transactions with MVCC-based snapshot isolation.
9+
10+
* Pluggable storage engine with [BitCask][bitcask] and [in-memory][memory] backends.
11+
12+
* Iterator-based query engine with heuristic optimization and time-travel support.
13+
14+
* SQL interface including joins, aggregates, and transactions.
15+
16+
toyDB is not distributed as a crate, see <https://github.com/erikgrinaker/toydb> for more.
17+
18+
This crate used to contain the [joydb](https://crates.io/crates/joydb) database. Thanks to Serhii
19+
Potapov for donating the crate name.

docs/crate/src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
//! This crate is just a simple README.md placeholder. toydb is not intended to be used as a
2+
//! library, and is not distributed as a crate. See <https://github.com/erikgrinaker/toydb>.

0 commit comments

Comments
 (0)