Document current extension capabilities

Author: harley

README.md

@@ -1,44 +1,37 @@
 # coderchart
 
-> a chrome extension tools built with Vite + React, and Manifest v3
+Chrome extension that renders Mermaid diagrams inline wherever ChatGPT (or another whitelisted site) shows a Mermaid code fence. Built with Vite, React, and Manifest V3.
 
-## Installing
+## Features
 
-1. Check if your `Node.js` version is >= **14**.
-2. Change or configurate the name of your extension on `src/manifest`.
-3. Run `npm install` to install the dependencies.
+- Auto-detects Mermaid snippets on supported pages and renders them beneath the original code block.
+- Handles live chat updates via a MutationObserver and avoids duplicate work with lightweight bookkeeping.
+- Resilient error messaging when Mermaid parsing fails.
+- Options page to toggle auto-rendering and manage the site whitelist powered by `chrome.storage.sync`.
+- Download rendered diagrams as SVG or PNG straight from the inline toolbar.
 
-## Developing
+## Getting Started
 
-run the command
-
-```shell
-$ cd coderchart
-
-$ npm run dev
+```bash
+pnpm install
+pnpm dev
 ```
 
-### Chrome Extension Developer Mode
-
-1. set your Chrome browser 'Developer mode' up
-2. click 'Load unpacked', and select `coderchart/build` folder
-
-### Nomal FrontEnd Developer Mode
+The dev server pipes hot reloads into the extension. Load the unpacked folder shown in the terminal (usually `dist`) via Chrome's Extensions page while Developer Mode is enabled.
 
-1. access `http://0.0.0.0:3000/`
-2. when debugging popup page, open `http://0.0.0.0:3000//popup.html`
-3. when debugging options page, open `http://0.0.0.0:3000//options.html`
+### Options & Settings
 
-## Packing
+- Open `options.html` during development (served at `http://localhost:5173/options.html`) to manage the whitelist or disable auto rendering.
+- Saved settings sync across Chrome instances via `chrome.storage.sync`.
 
-After the development of your extension run the command
+## Building
 
-```shell
-$ npm run build
+```bash
+pnpm run build
 ```
 
-Now, the content of `build` folder will be the extension ready to be submitted to the Chrome Web Store. Just take a look at the [official guide](https://developer.chrome.com/webstore/publish) to more infos about publishing.
+The production bundle lands in `dist/`. Package it manually or use `pnpm run zip` for a distributable archive.
 
 ---
 
-Generated by [create-chrome-ext](https://github.com/guocaoyi/create-chrome-ext)
+Bootstrapped with [create-chrome-ext](https://github.com/guocaoyi/create-chrome-ext)