Skip to content

Commit

Permalink
Add more crate-level documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
spencewenski committed Mar 30, 2024
1 parent 63f9565 commit 1c52033
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

![github ci](https://github.com/roadster-rs/roadster/actions/workflows/ci.yml/badge.svg?branch=main)

A "Batteries Included" web framework for rust designed to get you moving fast 🏎️. Inspired by other fully-featured
frameworks such as [Rails](https://rubyonrails.org/), [Loco](https://github.com/loco-rs/loco),
and [Poem](https://github.com/poem-web/poem).

## Features

- Built on Tokio's web stack (axum, tower, hyper, tracing). App behavior can be easily extended by taking advantage of
all the resources in the tokio ecosystem.
- Provides sane defaults so you can focus on building your app.
- Most of the built-in behavior can be customized or even disabled via per-environment configuration files.
- Uses `#![forbid(unsafe_code)]` to ensure all code in Roadster is 100% safe rust.

# Start local DB

```shell
Expand Down
12 changes: 10 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
//! # Roadster
//! A "Batteries Included" web framework for rust designed to get you moving fast 🏎️. Inspired by other fully-featured
//! frameworks such as [Rails](https://rubyonrails.org/), [Loco](https://github.com/loco-rs/loco),
//! and [Poem](https://github.com/poem-web/poem).
//!
//! Todo: Add documentation
//! ## Features
//!
//! - Built on Tokio's web stack (axum, tower, hyper, tracing). App behavior can be easily extended by taking advantage of
//! all the resources in the tokio ecosystem.
//! - Provides sane defaults so you can focus on building your app.
//! - Most of the built-in behavior can be customized or even disabled via per-environment configuration files.
//! - Uses `#![forbid(unsafe_code)]` to ensure all code in Roadster is 100% safe rust.
#![forbid(unsafe_code)]

Expand Down

0 comments on commit 1c52033

Please sign in to comment.