From 43d2028430be638b5c8246620f0d73b1f38bd0d6 Mon Sep 17 00:00:00 2001 From: Viktor Petersson Date: Fri, 8 Nov 2024 11:01:24 +0000 Subject: [PATCH] Fix up readme --- README.md | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a8f39da..b8298cb 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,18 @@ -Develop -------- +# Develop The extension is built using webpack. -``` -docker-compose up +```bash +$ docker compose up ``` Now load the content of the `dist/` folder as an unpacked extension in Chrome. As you make changes to the code, dist is automatically rebuilt. -Distribute ----------- +# Distribute -``` -docker-compose build -docker run \ +```bash +$ docker compose build +$ docker run \ --rm -ti \ -v $(pwd):/app:delegated \ -v /app/node_modules \ @@ -24,12 +22,11 @@ docker run \ (cd dist && zip -r ../screenly-chrome-extension-0.3.zip *) ``` -Unit testing ------------- +# Unit testing -``` -docker-compose build -docker run \ +```bash +$ docker compose build +$ docker run \ --rm -ti \ -v $(pwd):/app:delegated \ -v /app/node_modules \ @@ -40,4 +37,4 @@ docker run \ 1. Build the extension in dev mode. 2. Load the extension as an unpacked extension from the `dist` folder. -3. Find the extension URL and then open `chrome-extension://extension-id/test/tests.html` in Chrome. \ No newline at end of file +3. Find the extension URL and then open `chrome-extension://extension-id/test/tests.html` in Chrome.