Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ddfisher committed Apr 9, 2024
1 parent 287a73f commit 4ac6f5b
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,18 @@ If the feature `debug-embed` is enabled or the binary compiled in release mode a

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

## The `prefix` attribute
## Attributes
### `prefix`

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

### `metadata_only`

You can add `#[metadata_only = true]` to the `RustEmbed` struct to exclude file contents from the
binary. Only file paths and metadata will be embedded.

## Features

### `debug-embed`
Expand Down

0 comments on commit 4ac6f5b

Please sign in to comment.