From 403f0246457df56fa4acaf69db6ca9815941d765 Mon Sep 17 00:00:00 2001
From: Jay <wisehodl@pm.me>
Date: Thu, 5 Mar 2026 08:44:08 -0500
Subject: [PATCH] Created README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0245d3a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Go-Heartwood - Nostr Event Storage for Neo4j
+
+Source: https://git.wisehodl.dev/jay/go-heartwood
+
+Mirror: https://github.com/wisehodl/go-heartwood
+
+> **This library is in active development and not yet ready for use.**
+
+`go-heartwood` is a Neo4j-based event storage layer for Nostr events. It stores events as nodes in a graph and foreign-key references as relationships.
+
+## Installation
+
+Add `go-heartwood` to your project:
+
+```bash
+go get git.wisehodl.dev/jay/go-heartwood
+```
+
+If the primary repository is unavailable, use the `replace` directive in your go.mod file to get the package from the github mirror:
+
+```
+replace git.wisehodl.dev/jay/go-heartwood => github.com/wisehodl/go-heartwood latest
+```
+
+## Usage
+
+*Usage examples will be added as the API stabilizes.*
+
+## Testing
+
+Run tests with:
+
+```bash
+go test ./...
+```
+
+Run with race detector:
+
+```bash
+go test -race ./...
+```