Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention required dependencies in docs #77

Merged
merged 2 commits into from
Aug 1, 2021
Merged

Mention required dependencies in docs #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
007249d
Mention required dependencies in docs
davidpdrsn Aug 1, 2021
52be5e5
Merge branch 'main' into required-deps-in-docs
davidpdrsn Aug 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Improve documentation for routing ([#71](/~https://github.com/tokio-rs/axum/pull/71))
- Clarify required response body type when routing to `tower::Service`s ([#69](/~https://github.com/tokio-rs/axum/pull/69))
- Add `axum::body::box_body` to converting an `http_body::Body` to `axum::body::BoxBody` ([#69](/~https://github.com/tokio-rs/axum/pull/69))
- Mention required dependencies in docs ([#77](/~https://github.com/tokio-rs/axum/pull/77))
- Fix WebSockets failing on Firefox ([#76](/~https://github.com/tokio-rs/axum/pull/76))

## Breaking changes
Expand Down
22 changes: 22 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
//! - [Sharing state with handlers](#sharing-state-with-handlers)
//! - [Routing to any `Service`](#routing-to-any-service)
//! - [Nesting applications](#nesting-applications)
//! - [Required dependencies](#required-dependencies)
//! - [Examples](#examples)
//! - [Feature flags](#feature-flags)
//!
Expand Down Expand Up @@ -624,6 +625,27 @@
//! # };
//! ```
//!
//! # Required dependencies
//!
//! To use Axum there are a few dependencies you have pull in as well:
//!
//! ```toml
//! [dependencies]
//! axum = "<latest-version>"
//!
//! # For http types like `StatusCode`, `Method`, and `Response`
//! http = "<latest-version>"
//!
//! # "full" isn't strictly necessary for tokio and hyper but its the
//! # easiest way to get started.
//! hyper = { version = "<latest-version>", features = ["full"] }
//! tokio = { version = "<latest-version>", features = ["full"] }
//!
//! # Not strictly necessary but helpful for testing. There is a
//! # testing example in the repo that shows how to test axum apps.
//! tower = "<latest-version>"
//! ```
//!
//! # Examples
//!
//! The axum repo contains [a number of examples][examples] that show how to put all the
Expand Down