rust-embed

rust macro which loads files into the rust binary at compile time during release and loads the file from the fs during dev.

3c3c6bed — pyros2097

Improve documentation a bit

Files changed (1) hide show

readme.md CHANGED Viewed

@@ -17,12 +17,16 @@ rust-embed="3.0.0"
 ```
 ## Documentation
-Declare a struct name it Asset or something and add an attribute `folder` to it which has the path to your static folder.
+You need to add the custom derive macro RustEmbed to your struct with an attribute `folder` which is the path to your static folder.
 ```rust
 #[derive(RustEmbed)]
 #[folder = "examples/public/"]
 struct Asset;
 ```
+This macro add a single static method `get` to your type. This method allows you to get your assets from the fs during dev and from the binary during release. It takes the file path as string and returns an an optional vector of u8.
+```rust
+pub fn get(file_path: &str) -> Option<Vec<u8>>
+```
 ## Usage
 ```rust