Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kruserr committed Nov 26, 2023
1 parent 9ea9f39 commit 2de5577
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
6 changes: 3 additions & 3 deletions rapiddb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,6 @@ A reasonably fast configurable embedded key-value sensor database
- Bring your own database or API implementation
- Store sensor data inside a sensor database

## Optional REST API
Visit [further install options](https://github.com/kruserr/rapiddb/blob/main/docs/install.md#add-to-your-cargo-project).

## Getting started
Cargo.toml
```toml
Expand All @@ -59,6 +56,9 @@ Run the database with cargo
cargo run --release
```

## Optional REST API
Visit [further install options](https://github.com/kruserr/rapiddb/blob/main/docs/install.md#add-to-your-cargo-project).

## Documentation
Visit the [Documentation](https://docs.rs/rapiddb).

Expand Down
11 changes: 4 additions & 7 deletions rapiddb/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,14 @@
//! A reasonably fast configurable embedded key-value sensor database
//!
//! ## Features
//! - Lightweight embedded database
//! - Simple key-value database interface
//! - Simple and flexible optional embedded REST API
//! - Memory first with on-disk persistence
//! - Lightweight embedded database
//! - Memory Mapped Append-only Vector backing storage
//! - Bring your own database or API implementation
//! - Store sensor data inside a sensor database
//!
//! ## Documentation
//! Visit the [Documentation](https://docs.rs/rapiddb).
//!
//! ## Optional REST API
//! Visit the [rapiddb-web crates.io page](https://crates.io/crates/rapiddb-web).
//!
//! ## Getting started
//! Cargo.toml
//! ```toml
Expand All @@ -68,6 +62,9 @@
//! cargo run --release
//! ```
//!
//! ## Optional REST API
//! Visit [further install options](https://github.com/kruserr/rapiddb/blob/main/docs/install.md#add-to-your-cargo-project).
//!
//! ## Documentation
//! Visit the [Documentation](https://docs.rs/rapiddb).
//!
Expand Down

0 comments on commit 2de5577

Please sign in to comment.