From 98d722f20d6e325fb0b9713af3afbbbff20cfdf4 Mon Sep 17 00:00:00 2001
From: James Harton <james@harton.nz>
Date: Sat, 30 Sep 2023 19:29:38 +1300
Subject: [PATCH] docs: add current status to `README.md`.

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 8537b40..00caa09 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,30 @@
 An [Ash DataLayer](https://ash-hq.org/docs/module/ash/latest/ash-datalayer)
 which adds support for [CubDB](https://hex.pm/packages/cubdb).
 
+## Status
+
+AshCubDb is still a work in progress.  Feel free to give it a go.
+
+| Feature                 | Status |
+|-------------------------|--------|
+| Create                  | ✅     |
+| Upsert (by primary key) | ✅     |
+| Upsert (by identity)    | ❌     |
+| Read (all)              | ✅     |
+| Read (by primary key)   | ✅     |
+| Read (filters)          | ✅     |
+| Read (sort)             | ✅     |
+| Read (calculations)     | ❌     |
+| Read (aggregates)       | ❌     |
+| Update                  | ❌     |
+| Destroy                 | ❌     |
+
+## Github Mirror
+
+This repository is mirrored [on Github](https://github.com/jimsynz/smokestack)
+from it's primary location [on my Forejo instance](https://code.harton.nz/james/ash_cubdb).
+Feel free to raise issues and open PRs on Github.
+
 ## Installation
 
 If [available in Hex](https://hex.pm/docs/publish), the package can be installed