Skip to content

Commit

Permalink
docs(files: update readme from crate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robjtede committed Jan 10, 2024
1 parent 83be07d commit 08a9c66
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
22 changes: 16 additions & 6 deletions actix-files/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# `actix-files`

> Static file serving for Actix Web
<!-- prettier-ignore-start -->

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

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

## Documentation & Resources
<!-- cargo-rdme start -->

Static file serving for Actix Web.

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));
```

- [API Documentation](https://docs.rs/actix-files)
- [Example Project](https://github.com/actix/examples/tree/master/basics/static-files)
- Minimum Supported Rust Version (MSRV): 1.68
<!-- cargo-rdme end -->
5 changes: 5 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,8 @@ doc:
doc-watch:
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

# Update READMEs from crate root documentation.
update-readmes: && fmt
cd ./actix-files && cargo rdme --force
cd ./actix-router && cargo rdme --force

0 comments on commit 08a9c66

Please sign in to comment.