From 44a186911244b32c298a8e6d9ad42f9d4e46fb30 Mon Sep 17 00:00:00 2001 From: Sunli Date: Sat, 26 Sep 2020 11:25:21 +0800 Subject: [PATCH] Update readme --- README.md | 15 +++++++++++++++ src/lib.rs | 30 +++++++++++++++--------------- 2 files changed, 30 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3b5faba8..43dded53 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,21 @@ This crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in * Apollo Federation * Batch Queries +# Crate features + +This crate offers the following features, all of which are activated by default: + +- `apollo_tracing`: Enable the [Apollo tracing extension](extensions/struct.ApolloTracing.html). +- `log`: Enable the [logger extension](extensions/struct.Logger.html). +- `tracing`: Enable the [tracing extension](extensions/struct.Tracing.html). +- `multipart`: Support [sending files over HTTP multipart](http/fn.receive_body.html). +- `unblock`: Support [asynchronous reader for Upload](types/struct.Upload.html) +- `bson`: Integrate with the [`bson` crate](https://crates.io/crates/bson). +- `chrono`: Integrate with the [`chrono` crate](https://crates.io/crates/chrono). +- `chrono-tz`: Integrate with the [`chrono-tz` crate](https://crates.io/crates/chrono-tz). +- `url`: Integrate with the [`url` crate](https://crates.io/crates/url). +- `uuid`: Integrate with the [`uuid` crate](https://crates.io/crates/uuid). + ## Examples If you are just getting started, we recommend checking out our examples at: https://github.com/async-graphql/examples diff --git a/src/lib.rs b/src/lib.rs index 9e1d79af..1af1e889 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -49,6 +49,21 @@ //! * Apollo Federation //! * Batch Queries //! +//! # Crate features +//! +//! This crate offers the following features, all of which are activated by default: +//! +//! - `apollo_tracing`: Enable the [Apollo tracing extension](extensions/struct.ApolloTracing.html). +//! - `log`: Enable the [logger extension](extensions/struct.Logger.html). +//! - `tracing`: Enable the [tracing extension](extensions/struct.Tracing.html). +//! - `multipart`: Support [sending files over HTTP multipart](http/fn.receive_body.html). +//! - `unblock`: Support [asynchronous reader for Upload](types/struct.Upload.html) +//! - `bson`: Integrate with the [`bson` crate](https://crates.io/crates/bson). +//! - `chrono`: Integrate with the [`chrono` crate](https://crates.io/crates/chrono). +//! - `chrono-tz`: Integrate with the [`chrono-tz` crate](https://crates.io/crates/chrono-tz). +//! - `url`: Integrate with the [`url` crate](https://crates.io/crates/url). +//! - `uuid`: Integrate with the [`uuid` crate](https://crates.io/crates/uuid). +//! //! ## Integrations //! //! * Actix-web [async-graphql-actix_web](https://crates.io/crates/async-graphql-actix-web) @@ -92,21 +107,6 @@ //! //! Now a HTML report is available at `benchmark/target/criterion/report`. //! -//! # Crate features -//! -//! This crate offers the following features, all of which are activated by default: -//! -//! - `apollo_tracing`: Enable the [Apollo tracing -//! extension](extensions/struct.ApolloTracing.html). -//! - `log`: Enable the [logger extension](extensions/struct.Logger.html). -//! - `tracing`: Enable the [tracing extension](extensions/struct.Tracing.html). -//! - `multipart`: Support [sending files over HTTP multipart](http/fn.receive_body.html). -//! - `unblock`: Support [asynchronous reader for Upload](types/struct.Upload.html) -//! - `bson`: Integrate with the [`bson` crate](https://crates.io/crates/bson). -//! - `chrono`: Integrate with the [`chrono` crate](https://crates.io/crates/chrono). -//! - `chrono-tz`: Integrate with the [`chrono-tz` crate](https://crates.io/crates/chrono-tz). -//! - `url`: Integrate with the [`url` crate](https://crates.io/crates/url). -//! - `uuid`: Integrate with the [`uuid` crate](https://crates.io/crates/uuid). #![warn(missing_docs)] #![allow(clippy::trivially_copy_pass_by_ref)]