ripplo 0.2.1 → 0.3.0

package/README.md

@@ -90,23 +90,35 @@ After setup, your project will have:
 
 ```
 .ripplo/
-├── ripplo.ts          # Config: createRipplo({ projectId, appUrl, engineUrl, ... })
-├── ripplo.lock        # Generated + committed: compiled DSL the Ripplo server reads on push
-├── index.ts           # Entry point — explicitly imports every precondition, observer, and test file
-├── preconditions/     # Test data setup/teardown (add `import "./preconditions/<file>.js";` to index.ts)
-├── observers/         # Backend state assertions (add `import "./observers/<file>.js";` to index.ts)
-└── tests/             # Test specs (add `import "./tests/<id>.js";` to index.ts)
+├── ripplo.ts                # createRipplo(config, { preconditions, observers, tests })
+├── ripplo.lock              # Generated + committed: compiled DSL the Ripplo server reads on push
+├── index.ts                 # Re-exports the ripplo instance + registries
+├── preconditions/index.ts   # Exports each precondition handle + a `preconditions` registry
+├── observers/index.ts       # Exports each observer handle + an `observers` registry
+└── tests/
+    ├── index.ts             # Composes all tests into a `tests` array
+    └── <test-id>.ts         # Each file exports one TestDefinition
 ```
 
-Configuration lives in `ripplo.ts` via `createRipplo()`:
+Configuration lives in `ripplo.ts` via `createRipplo()`. It takes two arguments: the config, and the three registries composed from the folders above.
 
 ```ts
-const ripplo = createRipplo({
-  appUrl: "http://localhost:3000",
-  engineUrl: "http://localhost:3000/ripplo",
-  projectId: "your-project-id",
-  webhookSecret: process.env["RIPPLO_WEBHOOK_SECRET"] ?? "",
-});
+import { createRipplo } from "@ripplo/testing";
+import { preconditions } from "./preconditions/index.js";
+import { observers } from "./observers/index.js";
+import { tests } from "./tests/index.js";
+
+export default createRipplo(
+  {
+    appUrl: "http://localhost:3000",
+    engineUrl: "http://localhost:3000/ripplo",
+    projectId: "your-project-id",
+    webhookSecret: process.env["RIPPLO_WEBHOOK_SECRET"] ?? "",
+  },
+  { preconditions, observers, tests },
+);
 ```
 
+Implementations (precondition setup/teardown, observer functions) live in your app server via `createEngine(ripplo, { preconditions, observers })` — see `@ripplo/testing`'s README for the full wiring.
+
 Learn more at [ripplo.ai](https://ripplo.ai).