From d15a731b60f13594218724c2eca083b23a21e44a Mon Sep 17 00:00:00 2001
From: Relationship <139162359+Relationship-OctoWoW@users.noreply.github.com>
Date: Wed, 15 Jul 2026 15:25:05 +0100
Subject: [PATCH] Create README.md

---
 README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ff3cc43
--- /dev/null
+++ b/README.md
@@ -0,0 +1,73 @@
+# Relationships Auction Price
+
+**Relationships Auction Price** is a lightweight Auction House addon for **OctoWoW** that combines a powerful Auction House scanner with informative item tooltips, giving you instant access to market prices without repeatedly searching the Auction House.
+
+Designed to stay true to the original WoW interface, Relationships Auction Price adds a compact control panel directly above the Auction House, making it easy to perform scans while keeping Blizzard's default UI clean and familiar.
+
+## Features
+
+### 📊 Auction House Scanner
+
+Build your own local Auction House database by scanning current listings.
+
+* Full Auction House scans.
+* Filtered scans by **item name** or **item class**.
+* Automatically records buyout prices from all scanned auctions.
+* Resume interrupted scans without losing progress.
+* Stores data locally for fast tooltip lookups.
+
+Because OctoWoW uses Auction House query throttling, a **complete scan takes approximately 1 hour** to finish. This is normal and ensures reliable data collection without disconnects.
+
+### 🏷️ Enhanced Item Tooltips
+
+Whenever you hover over an item, RAP displays Auction House pricing information directly in the tooltip.
+
+Tooltip information includes:
+
+* Highest recorded unit price
+* Mid-market unit price
+* Lowest recorded unit price
+* Age of your most recent local scan
+* Whether prices are from the included shared database or your own scans
+
+This lets you quickly judge an item's approximate market value while looting, crafting, trading, or browsing your inventory.
+
+### 📦 Included Price Database
+
+The addon comes with a large built-in Auction House database, allowing tooltip prices to work immediately after installation without requiring an initial scan.
+
+**However, Auction House prices constantly change.** The included database is simply a starting point and should not be considered permanently accurate.
+
+For the best and most up-to-date pricing, it is **strongly recommended that you perform your own manual Auction House scan** after installing the addon. Your local scan data is automatically used alongside the shared data, ensuring your tooltips reflect your server's current market whenever possible.
+
+## Clean Integration
+
+Relationships Auction Price integrates naturally into the default Auction House.
+
+The scanner panel sits neatly above the Browse tab and includes:
+
+* Name filter
+* Item class filter
+* One-click Scan button
+* Live scan status updates
+
+No extra windows or complicated configuration are required.
+
+## Ideal For
+
+* Auction House traders
+* Gold makers
+* Farmers
+* Crafters
+* Players checking item values while questing or raiding
+* Anyone who wants instant market information without searching every item manually
+
+## Notes
+
+* ✔ Includes a large shared pricing database out of the box.
+* ✔ Local scans automatically supplement and update the included data.
+* ✔ Full Auction House scans take **around 1 hour** to complete.
+* ✔ Prices naturally become outdated as the market changes, so regular manual scans are recommended to keep your data accurate.
+* ✔ Lightweight with minimal impact on performance.
+
+Whether you're flipping valuable items, deciding what to vendor, or simply curious about an item's worth, **Relationships Auction Price** provides quick, reliable Auction House pricing directly where you need it—inside every item tooltip.