From c1f8ebaa5fa598bb322ebed06f919b1a6d083cda Mon Sep 17 00:00:00 2001
From: Max Litruv Boonzaayer <litruv@gmail.com>
Date: Mon, 13 Jan 2025 17:19:10 +1100
Subject: [PATCH] Update README.md

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0a99b6b..91f17d1 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,35 @@
-# Obsidian-BlueprintUE
\ No newline at end of file
+# BlueprintUE Embed for Obsidian
+
+Embed BlueprintUE renderings directly in your Obsidian notes.
+
+## Usage
+
+To embed a BlueprintUE, use the following syntax in your notes:
+
+```md
+[bpue https://blueprintue.com/blueprint/xxxx/]
+```
+
+Replace `xxxx` with your BlueprintUE blueprint ID.
+
+## Example
+
+```md
+[bpue https://blueprintue.com/blueprint/t4ed27qf/]
+```
+
+## Features
+
+- Automatically converts BlueprintUE links into embedded iframes
+- Responsive width that adjusts to your note's width
+- Fixed height of 643px for optimal viewing *blueprintue limitation*
+- Supports fullscreen mode
+
+
+## Support
+
+For issues and feature requests, please visit the [GitHub repository](https://github.com/litruv/Obsidian-BlueprintUE).
+
+## Credits
+
+Developed by [Litruv](https://lit.ruv.wtf)