From 11c5cd382eb2d5a0ce977f4f019ca8ea7d3790c9 Mon Sep 17 00:00:00 2001
From: jeirmeister <jeir@jeirslab.xyz>
Date: Fri, 18 Jul 2025 11:03:43 -0700
Subject: [PATCH] Added README and shell

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 shell.nix |  7 +++++++
 2 files changed, 40 insertions(+)
 create mode 100644 README.md
 create mode 100644 shell.nix

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2e7250b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# BTCPay Server Deployment
+
+This project deploys a BTCPay Server with a Bitcoin node using Nix.
+
+## Prerequisites
+
+- **Nix package manager** - If you're not using NixOS, install from https://nixos.org/download/
+- **SSH keys configured** for root access to your target server
+
+## Setup
+
+1. **Configure your server**: Edit `REMOTE_HOST` in `justfile` to point to your server
+2. **SSH access**: Ensure you have SSH keys configured for root access to your target server
+
+## Quick Start
+
+```bash
+# Enter development environment (provides just automatically)
+nix-shell
+
+# Build configuration
+just build
+
+# Deploy to server
+just deploy
+
+# Check status
+just status
+```
+
+## What You Need
+
+The `shell.nix` provides `just` and everything else needed. If you already have `just` installed, you can skip `nix-shell` and run the commands directly.
diff --git a/shell.nix b/shell.nix
new file mode 100644
index 0000000..1f60faf
--- /dev/null
+++ b/shell.nix
@@ -0,0 +1,7 @@
+{ pkgs ? import <nixpkgs> {} }:
+
+pkgs.mkShell {
+  buildInputs = with pkgs; [
+    just
+  ];
+}