azot 5.0.0-alpha.87 → 5.0.0-alpha.89

package/README.md

@@ -1,55 +1,50 @@
-# Azot
+# azot
 
-## Extensions API
+Tools for building [Azot](https://azot.mov) extensions: the extension API and its types, the `azot build`, `azot dev` and `azot manifest` commands, and `azot/vitest` for unit tests.
 
-Type definitions for the latest [Azot](https://azot.mov) API.
+This package does not download videos. To use Azot, get the [desktop app](https://azot.mov/download), which can also add the `azot` command from its settings, or install the standalone CLI:
 
-Check [docs](https://azot.mov/docs/extensions/globals) or [TypeScript definitions](https://npmx.dev/package-code/azot/v/5.0.0-alpha.18/types) to get started with our API. If you want to discover and install extensions, check out [Extension List](https://azot.mov/extensions).
+```shell
+# macOS (Apple Silicon) and Linux (x64)
+curl -fsSL https://azot.mov/install.sh | sh
 
-## Command-line interface
+# Windows (x64)
+powershell -c "irm azot.mov/install.ps1 | iex"
+```
 
-### Quick Start
+## Get started
 
-Run following command to install Azot CLI globally ([Node.js](https://nodejs.org/en/download) 24 or higher is required):
+Add the package to your extension as a development dependency ([Node.js](https://nodejs.org/en/download) 24 or newer):
 
 ```shell
-npm install -g azot
+npm i -D azot@alpha
 ```
 
-> Use `azot --help` command to see all available options.
-
-Update an npm-installed CLI with `npm install -g azot@latest`. Install a specific
-version with `npm install -g azot@<version>`. The desktop-distributed CLI is updated
-with the desktop application. `azot install` installs extensions; the current CLI
-does not expose `upgrade`, `downgrade`, or `global` commands.
-
-Install `premier` extension to download videos from [PREMIER](https://premier.one/)):
-
-```shell
-azot install premier
+```ts
+import { defineExtension, defineProvider } from "azot";
+
+export default defineExtension({
+  title: "Hello world",
+  site: defineProvider({
+    matches: ["https://*.example.com/*"],
+    async list({ url }) {
+      return [];
+    },
+  }),
+});
 ```
 
-Download a video from [RUTUBE](https://rutube.ru/) using built-in `rutube` extension:
+- `npx azot build` bundles the extension into `dist/` and writes `manifest.json` from its code.
+- `npx azot dev` rebuilds on every change.
+- `npx azot manifest` regenerates `manifest.json` without a release build.
 
-```shell
-azot https://rutube.ru/video/a5d8e842f1b9ea08d9f64cd78d7e722e/
-```
+Load the folder in Azot with `azot <url> --extension ./my-extension`, or **Load from folder** in the desktop app.
 
-```text
-11:19:44.874   INFO     Fetching content metadata...
-11:19:45.257   INFO     Fetching metadata finished
-11:19:45.289   INFO     Как речной транспорт экономит время москвичей? — Москва 24
-11:19:45.290   INFO     Content Matched: HTTP Live Streaming
-11:19:45.290   INFO     Parsing streams...
-11:19:46.223   INFO     Extracted, there are 16 tracks, 8 video tracks, 8 audio tracks
-11:19:46.226   INFO     Как речной транспорт экономит время москвичей — Москва 24 (480p, avc) ∙ VIDEO ∙ 848x480 ∙ 485 KiB/s
-✔:19:46.226   INFO     Downloading ∙ 21.77 MB
-11:19:52.761   INFO     Как речной транспорт экономит время москвичей — Москва 24 (480p, avc) ∙ AUDIO ∙ UND ∙ 44100 kHz ∙ 485 KiB/s
-✔:19:52.762   INFO     Downloading ∙ 21.77 MB
-✔:19:57.009   INFO     Muxed
-```
+Follow the [tutorial](https://azot.mov/docs/extensions/build-extension) and the [API reference](https://azot.mov/docs/extensions/api) for the rest. Public extensions are listed on the [Sites](https://azot.mov/sites) page.
+
+## Verify a package build
 
-> You can find downloaded video in `~/Downloads/` directory by default.
+After `pnpm pack:publish`, run `npm run verify:package -- /absolute/path/to/azot-<version>.tgz` from this directory. The check installs the tarball into a temporary directory and builds a small extension with the installed `azot`, without workspace paths. It does not publish the package.
 
 ## Community