Skip to content

Commit

Permalink
updated version and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyhalight committed Nov 20, 2024
1 parent ecc0925 commit e4f996e
Show file tree
Hide file tree
Showing 12 changed files with 102 additions and 7 deletions.
6 changes: 6 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vot.js",
"version": "2.0.0",
"version": "2.0.1",
"author": "Toil",
"repository": {
"type": "git",
Expand Down
26 changes: 26 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@vot.js/core",
"description": "core package",
"version": "2.0.0",
"version": "2.0.1",
"author": "Toil",
"license": "MIT",
"repository": {
Expand Down
32 changes: 32 additions & 0 deletions packages/ext/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/ext/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
29 changes: 29 additions & 0 deletions packages/node/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/node/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# @vot.js/shared

Shared content for all @vot.js package

To install:

```bash
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/data/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ export default {
defaultDuration: 343,
minChunkSize: 5295308,
loggerLevel: 1,
version: "2.0.0",
version: "2.0.1",
} as ConfigSchema;
2 changes: 1 addition & 1 deletion packages/shared/src/protos/yandex.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e4f996e

Please sign in to comment.