diff --git a/README.md b/README.md index 91c174e0..781dc446 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/lib.rs b/src/lib.rs index 40280ef7..4b6f1d86 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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)]