From d6499ed5ab81b565e5b053797e43df0c90128e5d Mon Sep 17 00:00:00 2001
From: Chris Thoburn <runspired@users.noreply.github.com>
Date: Sat, 28 Sep 2024 00:27:57 -0700
Subject: [PATCH] add basic readme

---
 packages/eslint-plugin-ember-data/README.md   | 28 +++++++++++++++++++
 .../eslint-plugin-ember-data/package.json     |  3 +-
 2 files changed, 30 insertions(+), 1 deletion(-)
 create mode 100644 packages/eslint-plugin-ember-data/README.md

diff --git a/packages/eslint-plugin-ember-data/README.md b/packages/eslint-plugin-ember-data/README.md
new file mode 100644
index 0000000000..cfee8d52f7
--- /dev/null
+++ b/packages/eslint-plugin-ember-data/README.md
@@ -0,0 +1,28 @@
+# eslint-plugin-warp-drive
+
+> [!TIP]
+> This Package is also available as eslint-plugin-ember-data
+
+## Rules
+
+- 🛠️ has Autofix
+- 〽️ has Partial Autofix
+- ✅ Recommended
+- 💜 TypeScript Aware
+
+| Rule | Description | Category | ✨ |
+| ---- | ----------- | -------- | -- |
+| no-create-record-rerender | Helps avoid patterns that often lead to excess or broken renders | 🐞⚡️ | ✅ |
+| no-methods-in-models      | restricts adding methods to model classes | usage | ✅ |
+| no-computeds-in-models    | restricts adding computed properties to model classes | usage | ✅ |
+| no-getters-in-models      | restricts adding getters/setters to model classes | usage | ✅ |
+| no-complex-derivations    | Helps avoid patterns that often lead to buggy or brittle code | 🐞 | ✅ |
+| no-legacy-transforms             | Restricts usage of attr transforms on models that often lead to buggy or brittle code | 🐞 | ✅ |
+| no-peek-all               | Restricts peekAll usage to reduce bugs and improve perf | 🐞⚡️ | ✅ |
+| no-peek-record            | Restricts peekRecord usage to reduce bugs | 🐞 | ✅ |
+| no-direct-imports         | Assists in usage of a whitelabel/repackaged app/company configured experience | usage | 🛠️ |
+| no-string-includes        | Avoids a pattern that doesn't typecheck as nicely | usage | ✅ 🛠️ |
+| no-invalid-relationships  | Ensures relationship configuration is setup appropriately | usage | ✅ 〽️ |
+| no-legacy-methods         | Restricts usage of deprecated methods | usage | ✅ 〽️ |
+| no-loose-resource-types   | Prevents usage of incorrect resource-types | usage | ✅ 〽️ |
+| no-loose-ids              | Prevents usage of non-string IDs | usage | ✅ 🛠️ |
diff --git a/packages/eslint-plugin-ember-data/package.json b/packages/eslint-plugin-ember-data/package.json
index 02c0c9c079..226c7b9a21 100644
--- a/packages/eslint-plugin-ember-data/package.json
+++ b/packages/eslint-plugin-ember-data/package.json
@@ -22,7 +22,8 @@
   },
   "files": [
     "src",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "README.md"
   ],
   "scripts": {
     "test": "mocha tests"