Skip to content

Commit

Permalink
docs(multipart): use cargo-rdme
Browse files Browse the repository at this point in the history
  • Loading branch information
robjtede committed Jun 10, 2024
1 parent cc5030c commit 132b84d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 15 deletions.
21 changes: 6 additions & 15 deletions actix-multipart/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# `actix-multipart`

> Multipart form support for Actix Web.
<!-- prettier-ignore-start -->

[![crates.io](https://img.shields.io/crates/v/actix-multipart?label=latest)](https://crates.io/crates/actix-multipart)
Expand All @@ -15,18 +13,13 @@

<!-- prettier-ignore-end -->

## Example
<!-- cargo-rdme start -->

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 &rarr;](https://github.com/actix/examples/tree/master/forms/multipart)

```rust
use actix_web::{post, App, HttpServer, Responder};
Expand Down Expand Up @@ -63,6 +56,8 @@ async fn main() -> std::io::Result<()> {
}
```

<!-- cargo-rdme end -->

Curl request :

```bash
Expand All @@ -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
2 changes: 2 additions & 0 deletions actix-multipart/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
//! Multipart form support for Actix Web.
//!
//! # Examples
//!
//! ```no_run
//! use actix_web::{post, App, HttpServer, Responder};
//!
Expand Down
1 change: 1 addition & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 132b84d

Please sign in to comment.