mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-24 00:21:08 +01:00
docs(files: update readme from crate docs
This commit is contained in:
parent
83be07d77d
commit
08a9c66568
@ -1,7 +1,5 @@
|
|||||||
# `actix-files`
|
# `actix-files`
|
||||||
|
|
||||||
> Static file serving for Actix Web
|
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
|
|
||||||
[![crates.io](https://img.shields.io/crates/v/actix-files?label=latest)](https://crates.io/crates/actix-files)
|
[![crates.io](https://img.shields.io/crates/v/actix-files?label=latest)](https://crates.io/crates/actix-files)
|
||||||
@ -15,8 +13,20 @@
|
|||||||
|
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
## Documentation & Resources
|
<!-- cargo-rdme start -->
|
||||||
|
|
||||||
- [API Documentation](https://docs.rs/actix-files)
|
Static file serving for Actix Web.
|
||||||
- [Example Project](https://github.com/actix/examples/tree/master/basics/static-files)
|
|
||||||
- Minimum Supported Rust Version (MSRV): 1.68
|
Provides a non-blocking service for serving static files from disk.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
```rust
|
||||||
|
use actix_web::App;
|
||||||
|
use actix_files::Files;
|
||||||
|
|
||||||
|
let app = App::new()
|
||||||
|
.service(Files::new("/static", ".").prefer_utf8(true));
|
||||||
|
```
|
||||||
|
|
||||||
|
<!-- cargo-rdme end -->
|
||||||
|
5
justfile
5
justfile
@ -14,3 +14,8 @@ doc:
|
|||||||
doc-watch:
|
doc-watch:
|
||||||
RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly doc --no-deps --workspace --features=rustls,openssl --open
|
RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly doc --no-deps --workspace --features=rustls,openssl --open
|
||||||
cargo watch -- RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly doc --no-deps --workspace --features=rustls,openssl
|
cargo watch -- RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly doc --no-deps --workspace --features=rustls,openssl
|
||||||
|
|
||||||
|
# Update READMEs from crate root documentation.
|
||||||
|
update-readmes: && fmt
|
||||||
|
cd ./actix-files && cargo rdme --force
|
||||||
|
cd ./actix-router && cargo rdme --force
|
||||||
|
Loading…
Reference in New Issue
Block a user