docs(README): update description

Author: thuongtruong109

.npmignore

@@ -1,21 +1,22 @@
-# v1.2.1 - 2025-08-26
+# v1.2.0 - 2025-08-26
 
 ## What changed
 
-- Refactor code into smaller modules
+- [Modularize refactor code](https://github.com/thuongtruong109/flashot/commit/f7332a493590b8f74485da727b7d54e23decb614)
 - Image generation format choice (WebP, Png, Jpeg)
 - Quality setting for Jpeg images
 - Define tokens style (ThemedToken)
 - Change default font family (JetBrains Mono)
 - Fix width size rendering
 - Improved error handling for invalid input
-- Ignore publish non-related files
+- Ignore publish non-related files (public/\*\*)
+- Update README description
 
 # v1.1.0 - 2025-08-25
 
 ## What changed
 
-- Added support for fetching code snippets from URLs
+- [Added support for fetching code snippets from URLs](https://github.com/thuongtruong109/flashot/commit/b1396d761c58415a77a7e68a9bb966f217762a10)
 - Improved image generation speed and quality
 - Enhanced customization options for themes and styles
 

CHANGELOG.md

@@ -21,17 +21,21 @@ Flashot is the **blazing-fast image generation tool** for code snippets, designe
 
 **Super fast:** (generated in **~135ms**)
 
-  <img src="./test/.snapshot/demo.png" alt="Example output" />
+  <img src="./test/.snapshot/demo.webp" alt="Example output" />
 </div>
 
 ## ✨ Features
 
 - 💻 **Inline code support:** Easily convert inline code snippets to images
 - 🌐 **URL support:** Fetch code snippets directly from URLs
-- 🎨 **Customizable themes:** Choose from various themes to match your style
+- 🎨 **Customizable styles:** Choose from various options to match your style
 - 🖼️ **High-quality output:** Generates crisp and clear images which keep the original code's formatting intact
 - ⚡ **Blazing fast:** Optimized for speed, ensuring quick image generation
-- 🛠️ **Flexible API:** Easy to integrate into your projects with a simple API
+- 🛠️ **Easy to use:** Easy to integrate into your projects with a simple API
+- 🪓 **Multi-format support:** Generate images in various formats (PNG, JPEG, WebP)
+- 🔷 **TypeScript support:** Fully typed for better developer experience
+- 🔍 **Extensive testing:** Thoroughly tested with a comprehensive suite of unit tests
+- 🔋 **Easy integration:** Simple API for seamless integration into your projects
 
 ## 📦 Installation
 
@@ -88,10 +92,12 @@ Then you can use the `buffer` to display the image or send it in a response.
 const defaultOptions = {
   lang: "ts", // default is javascript
   theme: "ayu-dark", // default is github-dark
-  font: "https://fonts.bunny.net/ubuntu-sans-mono/files/ubuntu-sans-mono-latin-400-normal.woff2", // custom font
-  width: 800, // default is auto
-  height: 400, // default is auto
-  bg: "transparent", // default is theme's background
+  font: "https://fonts.bunny.net/ubuntu-sans-mono/files/ubuntu-sans-mono-latin-400-normal.woff2", // default is bunny.net/jetbrains-mono.
+  format: OutputFormat.Png, // default is OutputFormat.Webp, has three options: OutputFormat.Png, OutputFormat.Jpeg, OutputFormat.Webp
+  quality: 100, // default is 100 (1-100), only applies to JPEG formats
+  width: 800, // default is system's width
+  height: 400, // default is system's height
+  bg: "transparent", // default is system's background
   gap: 1, // gap between lines (default is 1)
   style: {
     borderRadius: 10, // default is 8
@@ -101,24 +107,26 @@ const defaultOptions = {
 };
 ```
 
-| Option   | Description                                                                              | Default                                                                                            |
-| -------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `lang`   | Code language ([supported](https://shiki.style/languages))                               | `"js"`                                                                                             |
-| `theme`  | Rendering theme ([supported](https://shiki.style/themes))                                | `"github-dark"`                                                                                    |
-| `font`   | Font for rendering (URL or ArrayBuffer)                                                  | [`ubuntu`](https://fonts.bunny.net/ubuntu-sans-mono/files/ubuntu-sans-mono-latin-400-normal.woff2) |
-| `width`  | Image width                                                                              | System default                                                                                     |
-| `height` | Image height                                                                             | System default                                                                                     |
-| `bg`     | Background color                                                                         | Theme's background                                                                                 |
-| `gap`    | Gap between lines                                                                        | `1`                                                                                                |
-| `style`  | Additional container styles ([docs](https://takumi.kane.tw/docs/deep-dives/stylesheets)) | `{ borderRadius: 8, padding: 25 }`                                                                 |
+| Option    | Description                                                                              | Default                                                                                                |
+| --------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `lang`    | Code language ([supported](https://shiki.style/languages))                               | `"js"`                                                                                                 |
+| `theme`   | Rendering theme ([supported](https://shiki.style/themes))                                | `"github-dark"`                                                                                        |
+| `font`    | Font for rendering (URL or ArrayBuffer)                                                  | [`Jetbrains Mono`](https://fonts.bunny.net/jetbrains-mono/files/jetbrains-mono-latin-400-normal.woff2) |
+| `format`  | Output image format (`OutputFormat.Png`, `OutputFormat.Jpeg`, `OutputFormat.Webp`)       | `OutputFormat.Webp`                                                                                    |
+| `quality` | Image quality (1-100) for JPEG formats                                                   | `100`                                                                                                  |
+| `width`   | Image width                                                                              | System default                                                                                         |
+| `height`  | Image height                                                                             | System default                                                                                         |
+| `bg`      | Background color                                                                         | Theme's background                                                                                     |
+| `gap`     | Gap between lines                                                                        | `1`                                                                                                    |
+| `style`   | Additional container styles ([docs](https://takumi.kane.tw/docs/deep-dives/stylesheets)) | `{ borderRadius: 8, padding: 25 }`                                                                     |
 
 ## 📚 Technologies
 
 - ⚡ **[Bun](https://bun.sh)** - Fast all-in-one JavaScript runtime and toolkit
 - 🏗️ **[TypeScript](https://www.typescriptlang.org/)** - Type-safe development with strict mode enabled
 - 📦 **[Vite](https://vitejs.dev/)** - Lightning-fast build tool with optimized bundling
-- 🔋 **[Vitest](https://vitest.dev/)** - Blazing fast unit testing & interactive test UI framework
-- 🪓 **[shiki](https://github.com/shikijs/shiki)** and **[takumi](https://github.com/kane50613/takumi)**
+- 🧪 **[Vitest](https://vitest.dev/)** - Blazing fast unit testing & interactive test UI framework
+- 🎨 **[shiki](https://github.com/shikijs/shiki)** and **[takumi](https://github.com/kane50613/takumi)**
 - 📝 **[Biome](https://biomejs.dev/)** - Fast formatter and linter for consistent code style
 - 🚀 **Dual Module Support** - ESM and CommonJS output with proper type definitions
 - 🔥 **[ESLint](https://eslint.org/)** - Advanced linting with TypeScript and SonarJS rules

README.md

@@ -1,7 +1,7 @@
 {
   "name": "flashot",
-  "description": "📟 Rapidly convert code snippets into images",
-  "version": "1.2.0",
+  "description": "📟 Rapidly snapshot code snippets as images",
+  "version": "1.2.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

package.json

@@ -28,7 +28,9 @@ export async function urlToImg(
   options?: ThemeOptions,
 ): Promise<Buffer<ArrayBufferLike>> {
   try {
-    const res = await fetch(url);
+    const res = await fetch(url, {
+      mode: "no-cors",
+    });
     const data2 = await res.text();
     return codeToImg(data2, options);
   } catch (err) {

src/index.ts

@@ -49,7 +49,9 @@ export async function codeToContainer(
 }
 
 export async function loadFont(font: string): Promise<ArrayBuffer> {
-  return await fetch(font).then((r) => r.arrayBuffer());
+  return await fetch(font, {
+    mode: "no-cors",
+  }).then((r) => r.arrayBuffer());
 }
 
 export function renderSize(code: string, opts: Required<ThemeOptions>) {

src/utils.ts

@@ -7,33 +7,30 @@ import { codeToImg, urlToImg } from "../src";
 
 describe("inline-test", () => {
   it("default", async () => {
-    const start = Date.now();
     const code = await readFile(fileURLToPath(import.meta.url), "utf8");
     const img = await codeToImg(code);
     const outDir = join(process.cwd(), "test/.snapshot");
     await mkdir(outDir, { recursive: true });
     const outPath = join(outDir, "inline.webp");
     await writeFile(outPath, img);
-    const end = Date.now();
-    console.log(`Image generated in ${end - start}ms`);
   });
 
   it("demo", async () => {
     const sampleCode = `<!DOCTYPE html>
-    <html lang="en">
-    <head>
-        <meta charset="UTF-8" />
-        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-        <link rel="icon" type="image/x-icon" href="favicon.ico" />
-        <title>Flashot</title>
-      </head>
-      <body>
-        <h1>Hello, world!</h1>
-        <p>
-          Welcome to Flashot, the tool for converting code snippets into images!
-        </p>
-      </body>
-    </html>`;
+      <html lang="en">
+      <head>
+          <meta charset="UTF-8" />
+          <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+          <link rel="icon" type="image/x-icon" href="favicon.ico" />
+          <title>Flashot</title>
+        </head>
+        <body>
+          <h1>Hello, world!</h1>
+          <p>
+            Welcome to Flashot, the tool for converting code snippets into images!
+          </p>
+        </body>
+      </html>`;
     const img = await codeToImg(sampleCode, {
       lang: "html",
       format: OutputFormat.WebP,
@@ -46,9 +43,9 @@ describe("inline-test", () => {
 
   it("custom", async () => {
     const sampleCode = `package main
-      func main() {
-          fmt.Println("Hello, world!")
-      }`;
+        func main() {
+            fmt.Println("Hello, world!")
+        }`;
     const img = await codeToImg(sampleCode, {
       lang: "go",
       bg: "transparent",