Merge pull request #118 from thefrontside/tm/minor-cleanup

Minor cleanup: Fix README and converge test flakiness

Author: taras

README.md

@@ -83,9 +83,9 @@ node --env-file=../.env --test "*.test.ts"
      "scripts": {
        "test": "node --env-file=../.env --test \"*.test.ts\""
      },
-     "dependencies": {
-       "effection": "^3"
-     }
+      "peerDependencies": {
+        "effection": "^3 || ^4"
+      }
    }
    ```
 
@@ -106,7 +106,7 @@ node --env-file=../.env --test "*.test.ts"
 
 4. Add your package to `pnpm-workspace.yaml`
 5. Add your package to `tsconfig.json` references
-6. Run `pnpm sync:tsrefs:fix` to update dependencies
+6. Run `pnpm sync:fix` to update dependencies
 7. Add a `README.md` (text before `---` will be used as a description)
 8. Add your source code and export it from `mod.ts`
 9. Add doc strings to your source code - they will be used for documentation

converge/converge.test.ts

@@ -225,7 +225,7 @@ describe("@effectionx/converge", () => {
       expect(stats.end).toBeGreaterThanOrEqual(end - 5);
       expect(stats.end).toBeLessThanOrEqual(end);
       expect(stats.elapsed).toBeGreaterThanOrEqual(50);
-      expect(stats.runs).toBeGreaterThanOrEqual(4); // ~50ms / 10ms interval = ~5 runs, allow for timing variance
+      expect(stats.runs).toBeGreaterThanOrEqual(3); // ~50ms / 10ms interval = ~5 runs, allow for timing variance on slower CI
       expect(stats.timeout).toEqual(50);
       expect(stats.interval).toEqual(10);
       expect(stats.value).toEqual(50);