update instructions

GaryB432 · Feb 5, 2024 · 7bc6f45 · 7bc6f45
1 parent a094490
commit 7bc6f45
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/packages/browser/src/generators/extension/__snapshots__/generator.spec.ts.snap b/packages/browser/src/generators/extension/__snapshots__/generator.spec.ts.snap
@@ -57,3 +57,16 @@ function makeInfoDiv(color = 'black'): HTMLDivElement {
 export {};
 "
 `;
+
+exports[`extension should work generally 3`] = `
+"# Sut0
+
+## Working with your extension
+
+### To install on Chrome
+
+Open chrome://extensions/ and make sure \`Developer mode\` is enabled in the top right corner.
+Then click the \`Load unpacked\` button and navigate to the \`dist/apps/sut0\` folder.
+Once installed, click the extension's icon in the browser's top right toolbar to see popup.html.
+"
+`;
diff --git a/packages/browser/src/generators/extension/files/README.md__tmpl__ b/packages/browser/src/generators/extension/files/README.md__tmpl__
@@ -2,4 +2,8 @@
 
 ## Working with your extension
 
-TODO add resource like icon generation, store portal, tips on workflow
+### To install on Chrome
+
+Open chrome://extensions/ and make sure `Developer mode` is enabled in the top right corner.
+Then click the `Load unpacked` button and navigate to the `dist/<%= appProjectRoot %>` folder.
+Once installed, click the extension's icon in the browser's top right toolbar to see popup.html.
diff --git a/packages/browser/src/generators/extension/generator.spec.ts b/packages/browser/src/generators/extension/generator.spec.ts
@@ -69,6 +69,10 @@ describe('extension', () => {
       }
     );
 
+    expect(
+      tree.read(`${directory}/README.md`, 'utf-8')
+    ).toMatchSnapshot();
+
     const rpconf = readProjectConfiguration(tree, name);
     expect(rpconf.targets!['build'].executor).toEqual('@nx/webpack:webpack');
     expect(rpconf.targets!['zip']).toEqual({