From e4f996e2c4e701daea336061dab7f691691a25cd Mon Sep 17 00:00:00 2001 From: Toil <62353659+ilyhalight@users.noreply.github.com> Date: Wed, 20 Nov 2024 20:52:08 +0300 Subject: [PATCH] updated version and readme --- changelog.md | 6 ++++++ package.json | 2 +- packages/core/README.md | 26 ++++++++++++++++++++++ packages/core/package.json | 2 +- packages/ext/README.md | 32 ++++++++++++++++++++++++++++ packages/ext/package.json | 2 +- packages/node/README.md | 29 +++++++++++++++++++++++++ packages/node/package.json | 2 +- packages/shared/README.md | 2 ++ packages/shared/package.json | 2 +- packages/shared/src/data/config.ts | 2 +- packages/shared/src/protos/yandex.ts | 2 +- 12 files changed, 102 insertions(+), 7 deletions(-) diff --git a/changelog.md b/changelog.md index 2bac117c..0a02f4ba 100644 --- a/changelog.md +++ b/changelog.md @@ -1,3 +1,9 @@ +# 2.0.1 + +## All + +- Fixed README for all packages + # 2.0.0 In this update, the library logic has been completely redesigned. diff --git a/package.json b/package.json index dffd781b..f256b6e8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vot.js", - "version": "2.0.0", + "version": "2.0.1", "author": "Toil", "repository": { "type": "git", diff --git a/packages/core/README.md b/packages/core/README.md index f53837a5..e5af673b 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,5 +1,31 @@ # @vot.js/core +Core package for vot.js. It has only basic functions without receiving video data or defining a video service + +## Usage + +```ts +import VOTClient from "@vot.js/core"; + +const client = new VOTClient(); + +const videoData = ...; + +const result = await client.translateVideo({ videoData }); +``` + +Proxying via [vot-worker](https://github.com/FOSWLY/vot-worker): + +```ts +import { VOTWorkerClient } from "@vot.js/core"; + +const client = new VOTWorkerClient({ + host: "vot.toil.cc", +}); +``` + +You can see more code examples [here](https://github.com/FOSWLY/vot.js/tree/main/examples) + To install: ```bash diff --git a/packages/core/package.json b/packages/core/package.json index 69b088ac..abb5c5f7 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,7 +1,7 @@ { "name": "@vot.js/core", "description": "core package", - "version": "2.0.0", + "version": "2.0.1", "author": "Toil", "license": "MIT", "repository": { diff --git a/packages/ext/README.md b/packages/ext/README.md index 7d63b1fc..fa04a9f0 100644 --- a/packages/ext/README.md +++ b/packages/ext/README.md @@ -1,5 +1,37 @@ # @vot.js/ext +Web extensions support package for vot.js. Includes: + +- additional support of Udemy and Coursera +- rewrited part of helpers for better perfomance and compatibility with DOM API + +## Usage + +```ts +import VOTClient from "@vot.js/ext"; +import { getVideoData } from "@vot.js/ext/utils/videoData"; + +const client = new VOTClient(); + +const videoData = await getVideoData("https://youtu.be/LK6nLR1bzpI"); + +const result = await client.translateVideo({ videoData }); +``` + +Proxying via [vot-worker](https://github.com/FOSWLY/vot-worker): + +```ts +import { VOTWorkerClient } from "@vot.js/ext"; + +const client = new VOTWorkerClient({ + host: "vot.toil.cc", +}); +``` + +You can see more code examples [here](https://github.com/FOSWLY/vot.js/tree/main/examples) + +## Install + To install: ```bash diff --git a/packages/ext/package.json b/packages/ext/package.json index cd08beac..62fcfe04 100644 --- a/packages/ext/package.json +++ b/packages/ext/package.json @@ -1,7 +1,7 @@ { "name": "@vot.js/ext", "description": "package for web extensions", - "version": "2.0.0", + "version": "2.0.1", "author": "Toil", "license": "MIT", "repository": { diff --git a/packages/node/README.md b/packages/node/README.md index 3302d3c9..34c01e5a 100644 --- a/packages/node/README.md +++ b/packages/node/README.md @@ -1,5 +1,34 @@ # @vot.js/node +JS Runtimes support package for vot.js + +## Usage + +```ts +import VOTClient from "@vot.js/node"; +import { getVideoData } from "@vot.js/node/utils/videoData"; + +const client = new VOTClient(); + +const videoData = await getVideoData("https://youtu.be/LK6nLR1bzpI"); + +const result = await client.translateVideo({ videoData }); +``` + +Proxying via [vot-worker](https://github.com/FOSWLY/vot-worker): + +```ts +import { VOTWorkerClient } from "@vot.js/node"; + +const client = new VOTWorkerClient({ + host: "vot.toil.cc", +}); +``` + +You can see more code examples [here](https://github.com/FOSWLY/vot.js/tree/main/examples) + +## Install + To install: ```bash diff --git a/packages/node/package.json b/packages/node/package.json index 533ddc69..47c40aaf 100644 --- a/packages/node/package.json +++ b/packages/node/package.json @@ -1,7 +1,7 @@ { "name": "@vot.js/node", "description": "package for runtimes", - "version": "2.0.0", + "version": "2.0.1", "author": "Toil", "license": "MIT", "repository": { diff --git a/packages/shared/README.md b/packages/shared/README.md index 4b6df40f..1b88389b 100644 --- a/packages/shared/README.md +++ b/packages/shared/README.md @@ -1,5 +1,7 @@ # @vot.js/shared +Shared content for all @vot.js package + To install: ```bash diff --git a/packages/shared/package.json b/packages/shared/package.json index ebf1e8be..701ca523 100644 --- a/packages/shared/package.json +++ b/packages/shared/package.json @@ -1,7 +1,7 @@ { "name": "@vot.js/shared", "description": "shared for all @vot.js package", - "version": "2.0.0", + "version": "2.0.1", "author": "Toil", "license": "MIT", "repository": { diff --git a/packages/shared/src/data/config.ts b/packages/shared/src/data/config.ts index 935148ea..27dff8a0 100644 --- a/packages/shared/src/data/config.ts +++ b/packages/shared/src/data/config.ts @@ -14,5 +14,5 @@ export default { defaultDuration: 343, minChunkSize: 5295308, loggerLevel: 1, - version: "2.0.0", + version: "2.0.1", } as ConfigSchema; diff --git a/packages/shared/src/protos/yandex.ts b/packages/shared/src/protos/yandex.ts index 8f557964..0fd3846e 100644 --- a/packages/shared/src/protos/yandex.ts +++ b/packages/shared/src/protos/yandex.ts @@ -1,7 +1,7 @@ // Code generated by protoc-gen-ts_proto. DO NOT EDIT. // versions: // protoc-gen-ts_proto v1.181.2 -// protoc v3.15.8 +// protoc v3.21.9 // source: src/protos/yandex.proto /* eslint-disable */