updated README with new modes

This commit is contained in:
Niklas Kapelle 2025-07-28 20:50:54 +02:00
parent aac8787410
commit 1a81ce8376
Signed by: niklas
GPG Key ID: 4EB651B36D841D16

View File

@ -1,11 +1,17 @@
Simple way to use [`include_bytes!`](https://doc.rust-lang.org/std/macro.include_bytes.html) for directories.
# Example
You can embed files two ways.
## Bytes mode
```rust
use dir_embed::Embed;
#[derive(Embed)]
#[dir = "../web/static"] // Path is relativ to the current file
#[mode = "bytes"] // Is the default. Can be omitted.
pub struct Assets;
fn main(){
@ -17,3 +23,19 @@ fn main(){
}
```
## Str mode
```rust
use dir_embed::Embed;
#[derive(Embed)]
#[dir = "../web/static"] // Path is relativ to the current file
#[mode = "str"]
pub struct Assets;
fn main(){
let file: &str = Assets::get("css/style.css").expect("Can't find file");
println!("{file}");
}
```