Skip to content

Commit 05de165

Browse files
authored
Stop calling axum a 'framework' (#3616)
1 parent 4077966 commit 05de165

File tree

7 files changed

+11
-11
lines changed

7 files changed

+11
-11
lines changed

ECOSYSTEM.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If your project isn't listed here and you would like it to be, please feel free
2424
- [axum-template](https://github.com/Altair-Bueno/axum-template): Layers, extractors and template engine wrappers for axum based Web MVC applications
2525
- [axum-template](https://github.com/janos-r/axum-template): GraphQL and REST API, SurrealDb, JWT auth, direct error handling, request logs
2626
- [axum-guard-logic](https://github.com/sjud/axum_guard_logic): Use AND/OR logic to extract types and check their values against `Service` inputs.
27-
- [axum-casbin-auth](https://github.com/casbin-rs/axum-casbin-auth): Casbin access control middleware for axum framework
27+
- [axum-casbin-auth](https://github.com/casbin-rs/axum-casbin-auth): Casbin access control middleware for axum
2828
- [aide](https://docs.rs/aide): Code-first Open API documentation generator with [axum integration](https://docs.rs/aide/latest/aide/axum/index.html).
2929
- [axum-typed-routing](https://docs.rs/axum-typed-routing/latest/axum_typed_routing/): Statically typed routing macros with OpenAPI generation using aide.
3030
- [axum-jsonschema](https://docs.rs/axum-jsonschema/): A `Json<T>` extractor that does JSON schema validation of requests.
@@ -115,7 +115,7 @@ If your project isn't listed here and you would like it to be, please feel free
115115

116116
- [Rust on Nails](https://rust-on-nails.com/): A full stack architecture for Rust web applications
117117
- [axum-tutorial] ([website][axum-tutorial-website]): axum tutorial for beginners
118-
- [demo-rust-axum]: Demo of Rust and axum web framework
118+
- [demo-rust-axum]: Demo of Rust and axum
119119
- [Introduction to axum (talk)]: Talk about axum from the Copenhagen Rust Meetup
120120
- [Getting Started with Axum]: axum tutorial, GET, POST endpoints and serving files
121121
- [Using Rust, Axum, PostgreSQL, and Tokio to build a Blog]

axum-core/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description = "Core types and traits for axum"
44
edition = "2021"
55
rust-version = { workspace = true }
66
homepage = "https://github.com/tokio-rs/axum"
7-
keywords = ["http", "web", "framework"]
7+
keywords = ["http", "web", "routing"]
88
license = "MIT"
99
name = "axum-core"
1010
readme = "README.md"

axum-extra/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description = "Extra utilities for axum"
44
edition = "2021"
55
rust-version = { workspace = true }
66
homepage = "https://github.com/tokio-rs/axum"
7-
keywords = ["http", "web", "framework"]
7+
keywords = ["http", "web", "routing"]
88
license = "MIT"
99
name = "axum-extra"
1010
readme = "README.md"

axum/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
name = "axum"
33
version = "0.8.8" # remember to bump the version that axum-extra depends on
44
categories = ["asynchronous", "network-programming", "web-programming::http-server"]
5-
description = "Web framework that focuses on ergonomics and modularity"
5+
description = "HTTP routing and request handling library that focuses on ergonomics and modularity"
66
edition = "2021"
77
rust-version = { workspace = true }
88
homepage = "https://github.com/tokio-rs/axum"
9-
keywords = ["http", "web", "framework"]
9+
keywords = ["http", "web", "routing"]
1010
license = "MIT"
1111
readme = "README.md"
1212
repository = "https://github.com/tokio-rs/axum"

axum/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# axum
22

3-
`axum` is a web application framework that focuses on ergonomics and modularity.
3+
`axum` is an HTTP routing and request-handling library that focuses on ergonomics and modularity.
44

55
[![Build status](https://github.com/tokio-rs/axum/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/tokio-rs/axum/actions/workflows/CI.yml)
66
[![Crates.io](https://img.shields.io/crates/v/axum)](https://crates.io/crates/axum)
@@ -17,7 +17,7 @@ More information about this crate can be found in the [crate documentation][docs
1717
- Take full advantage of the [`tower`] and [`tower-http`] ecosystem of
1818
middleware, services, and utilities.
1919

20-
In particular the last point is what sets `axum` apart from other frameworks.
20+
In particular the last point is what sets `axum` apart from other libraries / frameworks.
2121
`axum` doesn't have its own middleware system but instead uses
2222
[`tower::Service`]. This means `axum` gets timeouts, tracing, compression,
2323
authorization, and more, for free. It also enables you to share middleware with

axum/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! axum is a web application framework that focuses on ergonomics and modularity.
1+
//! axum is an HTTP routing and request-handling library that focuses on ergonomics and modularity.
22
//!
33
//! # High-level features
44
//!
@@ -9,7 +9,7 @@
99
//! - Take full advantage of the [`tower`] and [`tower-http`] ecosystem of
1010
//! middleware, services, and utilities.
1111
//!
12-
//! In particular, the last point is what sets `axum` apart from other frameworks.
12+
//! In particular, the last point is what sets `axum` apart from other libraries / frameworks.
1313
//! `axum` doesn't have its own middleware system but instead uses
1414
//! [`tower::Service`]. This means `axum` gets timeouts, tracing, compression,
1515
//! authorization, and more, for free. It also enables you to share middleware with

axum/src/routing/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ where
200200
}
201201

202202
#[doc = include_str!("../docs/routing/nest.md")]
203-
#[doc(alias = "scope")] // Some web frameworks like actix-web use this term
203+
#[doc(alias = "scope")] // Some other libs like actix-web use this term
204204
#[track_caller]
205205
pub fn nest(self, path: &str, router: Self) -> Self {
206206
if path.is_empty() || path == "/" {

0 commit comments

Comments
 (0)