From a6eba8386c73e90b611437b6b7d4e9cf319faea4 Mon Sep 17 00:00:00 2001
From: RGBCube <RGBCube@users.noreply.github.com>
Date: Thu, 4 Jan 2024 23:05:05 +0300
Subject: [PATCH] Add docs

---
 embed/src/lib.rs | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/embed/src/lib.rs b/embed/src/lib.rs
index 7b9824b..f92d58a 100644
--- a/embed/src/lib.rs
+++ b/embed/src/lib.rs
@@ -9,8 +9,6 @@ use std::{
     },
 };
 
-pub use embed_macros::__dir as dir;
-
 #[doc(hidden)]
 pub fn __string_runtime(neighbor: &str, path: &str) -> String {
     let base = Path::new(neighbor)
@@ -172,3 +170,16 @@ pub fn __dir_runtime(neighbor: &str, path: &str) -> Dir {
         path: directory,
     }
 }
+
+/// Embed a directories contents.
+/// The content value of File will be Borrowed on release,
+/// and Owned on debug.
+///
+/// # Example
+///
+/// ```
+/// fn main() {
+///     let content = embed::dir!("../assets");
+/// }
+/// ```
+pub use embed_macros::__dir as dir;