Initial commit

README.md

@@ -0,0 +1,45 @@
+# embed-rs
+
+A super simple file and directory embedding crate,
+that loads files from the filesystem in debug mode,
+allowing for quick edit-and-test cycles without compilation.
+
+On release mode it falls back to `include_str!`, `include_bytes!` and `include_dir!`.
+
+## Usage
+
+After running `cargo add embed`, you can do:
+
+```rs
+let contents: String = embed::string!("path/to/file.txt");
+let bytes: Vec<u8> = embed::bytes!("path/to/image.png");
+
+let dir: embed::Dir = embed::dir!("path/to/dir");
+
+```
+
+## License
+
+```
+MIT License
+
+Copyright (c) 2023-present RGBCube
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```