docs: refresh README

ClaudiuCeia · ClaudiuCeia · commit a2bd68c2a63a · 2026-02-08T08:11:59.000+02:00
diff --git a/README.md b/README.md
@@ -4,6 +4,12 @@ This package detects when a page is translated on the client (using, for example
 
 [![npm version](https://badge.fury.io/js/detect-translation.svg)](https://badge.fury.io/js/detect-translation)
 
+## What You Get
+
+- Detects translation type: `client`, `proxy`, or `unknown`
+- Detects translation service: `google`, `bing`, `yandex`, `baidu`, etc
+- Reports the target language via the document `<html lang="...">` attribute (plus heuristics for services that don’t set it reliably)
+
 ## Supported translators
 
 `detect-translation` can currently detect the following services:
@@ -36,9 +42,9 @@ This package detects when a page is translated on the client (using, for example
 pnpm add detect-translation
 ```
 
-_You can use npm or yarn if you prefer_
+_You can use npm or yarn if you prefer: `npm i detect-translation`, `yarn add detect-translation`_
 
-The package was written in Typescript, so no need to install types separately.
+The package is written in TypeScript and ships its own types.
 
 ---
 
@@ -49,18 +55,36 @@ import { observe } from "detect-translation";
 
 observe({
   onTranslation: (lang, { service, type }) => {
-    // type will be 'proxy', 'client' or 'unknown'
-    // service will be for example, 'google', 'bing', 'yandex', 'baidu' etc
-    // lang will be the BCP 47 code, for example zh, fr, ru, de, hi, es, pt etc
+    // type: "proxy" | "client" | "unknown"
+    // service: e.g. "google", "bing", "yandex", "baidu" (see Services enum)
+    // lang: a BCP 47-ish language tag (e.g. "zh", "fr", "ru", "de", "hi", "es", "pt")
     console.log(`${type} translation using ${service}, language ${lang}`);
   },
   sourceLang: "en",
 });
 ```
 
-Ensure that the script that calls `observe` is executed _after_ your HTML content.
+Ensure the script that calls `observe` runs after your HTML content is in the DOM.
+
+`lang` is based on the `<html>` [`lang` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) (set by the translation service when possible), or identified heuristically if you provide a “Skip to main content” link (see below).
+
+## Browser usage (no bundler)
+
+This package also ships a browser bundle that exposes a global `DetectTranslation` (useful for CDN usage).
+
+```html
+<script src="https://unpkg.com/detect-translation@latest/dist-browser/index.min.js"></script>
+<script>
+  DetectTranslation.observe({
+    sourceLang: "en",
+    onTranslation: function (lang, info) {
+      console.log(info.type, info.service, lang);
+    },
+  });
+</script>
+```
 
-`lang` is the value of the `<html>` [`lang` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) - this gets set by the translation service (or identified heuristically if you provide a “Skip to main content” link; see below).
+If you use a bundler, prefer the module import shown in “Getting started”.
 
 ## Advanced usage
 
@@ -147,4 +171,30 @@ It’s quite possible to use another phrase to identify translated content langu
 
 ---
 
+## Development
+
+This repository uses `pnpm`.
+
+Common commands:
+
+```bash
+pnpm install
+pnpm test
+pnpm run lint        # biome
+pnpm run knip        # dead-code / unused deps
+pnpm run build
+pnpm run prepublish  # the main verification gate (tests + lint + typecheck + knip + build + checks)
+```
+
+### Releases
+
+Releases are tag-driven:
+
+1. Bump `package.json` version.
+2. Create and push a tag like `v0.2.1`.
+
+GitHub Actions will run sanity checks and then publish to npm (requires the `NPM_TOKEN` repo secret), and create a GitHub Release with autogenerated notes.
+
+---
+
 MIT @ [Claudiu Ceia](https://github.com/ClaudiuCeia)
diff --git a/biome.json b/biome.json
@@ -7,7 +7,7 @@
   },
   "files": {
     "includes": [
-      "**",
+      "**/*",
       "!!**/dist",
       "!!**/dist-browser",
       "!!**/pkg",
