From 132b84d3b1f0f01a8a4923c442039ba46f845977 Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Mon, 10 Jun 2024 23:35:26 +0100 Subject: [PATCH] docs(multipart): use cargo-rdme --- actix-multipart/README.md | 21 ++++++--------------- actix-multipart/src/lib.rs | 2 ++ justfile | 1 + 3 files changed, 9 insertions(+), 15 deletions(-) diff --git a/actix-multipart/README.md b/actix-multipart/README.md index c7697785a..ef7630637 100644 --- a/actix-multipart/README.md +++ b/actix-multipart/README.md @@ -1,7 +1,5 @@ # `actix-multipart` -> Multipart form support for Actix Web. - [![crates.io](https://img.shields.io/crates/v/actix-multipart?label=latest)](https://crates.io/crates/actix-multipart) @@ -15,18 +13,13 @@ -## Example + -Dependencies: +Multipart form support for Actix Web. -```toml -[dependencies] -actix-multipart = "0.6" -actix-web = "4.5" -serde = { version = "1.0", features = ["derive"] } -``` +## Examples -Code: +[More available in the examples repo →](https://github.com/actix/examples/tree/master/forms/multipart) ```rust use actix_web::{post, App, HttpServer, Responder}; @@ -63,6 +56,8 @@ async fn main() -> std::io::Result<()> { } ``` + + Curl request : ```bash @@ -71,7 +66,3 @@ curl -v --request POST \ -F 'json={"name": "Cargo.lock"};type=application/json' \ -F file=@./Cargo.lock ``` - -### Examples - -https://github.com/actix/examples/tree/master/forms/multipart diff --git a/actix-multipart/src/lib.rs b/actix-multipart/src/lib.rs index d19e951e6..51b06db38 100644 --- a/actix-multipart/src/lib.rs +++ b/actix-multipart/src/lib.rs @@ -1,5 +1,7 @@ //! Multipart form support for Actix Web. +//! //! # Examples +//! //! ```no_run //! use actix_web::{post, App, HttpServer, Responder}; //! diff --git a/justfile b/justfile index 9f909bfac..d15ffcf67 100644 --- a/justfile +++ b/justfile @@ -90,6 +90,7 @@ update-readmes: && fmt cd ./actix-files && cargo rdme --force cd ./actix-http-test && cargo rdme --force cd ./actix-router && cargo rdme --force + cd ./actix-multipart && cargo rdme --force cd ./actix-test && cargo rdme --force # Check for unintentional external type exposure on all crates in workspace.