Skip to content

Commit 4ac6f5b

Browse files
committed
add docs
1 parent 287a73f commit 4ac6f5b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

readme.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,18 @@ If the feature `debug-embed` is enabled or the binary compiled in release mode a
7575

7676
Otherwise the files are listed from the file system on each call.
7777

78-
## The `prefix` attribute
78+
## Attributes
79+
### `prefix`
7980

8081
You can add `#[prefix = "my_prefix/"]` to the `RustEmbed` struct to add a prefix
8182
to all of the file paths. This prefix will be required on `get` calls, and will
8283
be included in the file paths returned by `iter`.
8384

85+
### `metadata_only`
86+
87+
You can add `#[metadata_only = true]` to the `RustEmbed` struct to exclude file contents from the
88+
binary. Only file paths and metadata will be embedded.
89+
8490
## Features
8591

8692
### `debug-embed`

0 commit comments

Comments
 (0)