From c27cf816c41f1a4948e98d499fcb69c2281fdd91 Mon Sep 17 00:00:00 2001
From: Edward Faulkner <edward@eaf4.com>
Date: Tue, 3 Feb 2026 12:48:39 -0500
Subject: [PATCH] adding a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2d417f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# @embroider/try
+
+A tiny utility to support matrix testing.
+
+## List
+
+`pnpm -s @embroider/try list`
+
+Processes your `.try.mjs` file and emits JSON that can be used in GitHub Actions to create your `strategy.matrix`.
+
+## Apply
+
+`pnpm dlx @embroider/try apply $SCENARIO_NAME`
+
+Applies a scenario to your project by editing package.json, etc. Use this before the regular `pnpm install` or `npm install` in order to test differing dependencies.
+
+## Config File: .try.mjs
+
+```ts
+export default interface {
+  scenarios: Scenario[];
+}
+interface Scenario {
+  name: string;
+
+  // Values that will be merged into package.json:
+  //
+  //   npm: {
+  //     devDependencies: {
+  //       'ember-source': '^6.7.8'
+  //     }
+  //   }
+  npm?: {
+    devDependencies:  Record<string, string>;
+    dependencies:     Record<string, string>;
+    peerDependencies: Record<string, string>;
+    overrides:        Record<string, string>;
+  },
+
+  // Files that will be (over)written with the given contents
+  //
+  //   files: {
+  //     'tsconfig.json': '{ compilerOptions: {} }'
+  //   }
+  files?: Record<string, string>,
+}
+```