Merge pull request #38 from mainmatter/add-readme-images

chore(docs): copy README.md while publishing
mainmatter · Sep 10, 2024 · d9263f3 · d9263f3
2 parents 19d3cf7 + 8ec1274
commit d9263f3
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -55,6 +55,8 @@ globalThis.Testem?.afterTests(async (_config, _data, callback) => {
 });
 ```
 
+![Checking for any leaking classes](https://github.com/mainmatter/memory-leak-detector/blob/main/assets/memory_leak_1.png)
+
 This approach doesn't catch all memory-leaks as it will only detect the ones that have manipulated a window/document objects by e.g. storing references or not removed `addEventListener` calls.
 
 ### Asserting object count
@@ -84,3 +86,5 @@ test("paginating back and forth", async function (assert) {
   assert.strictEqual(currentURL(), "users");
 });
 ```
+
+![Checking for specific class in a test](https://github.com/mainmatter/memory-leak-detector/blob/main/assets/memory_leak_2.png)
diff --git a/assets/memory_leak_1.png b/assets/memory_leak_1.png
diff --git a/assets/memory_leak_2.png b/assets/memory_leak_2.png
diff --git a/packages/memory-leak-detector/.gitignore b/packages/memory-leak-detector/.gitignore
@@ -0,0 +1 @@
+./README.md
diff --git a/packages/memory-leak-detector/README.md b/packages/memory-leak-detector/README.md
diff --git a/packages/memory-leak-detector/package.json b/packages/memory-leak-detector/package.json
@@ -5,6 +5,7 @@
   "repository": "https://github.com/mainmatter/memory-leak-detector",
   "main": "index.js",
   "scripts": {
+    "prepublishOnly": "cp ../../README.md .",
     "start": "node server/index.js"
   },
   "keywords": [],