Skip to content

Commit

Permalink
updated & improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyhalight committed Jun 15, 2024
1 parent c995594 commit 51acf64
Show file tree
Hide file tree
Showing 9 changed files with 1,608 additions and 15 deletions.
13 changes: 6 additions & 7 deletions README-EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
> [!CAUTION]
> Before creating Issues, we strongly recommend that you read the [FAQ](https://github.com/ilyhalight/voice-over-translation/wiki/%5BEN%5D-FAQ) section, as well as with existing [Issues](https://github.com/ilyhalight/voice-over-translation/issues)
> [!WARNING]
> If you use Tampermonkey 5.2.0+, don't forget to [enable](https://github.com/ilyhalight/voice-over-translation/issues/662#issuecomment-2160768958) Developer mode or use Tampermonkey MV2
The voice-over translation of the video is now available not only in YandexBrowser. Very grateful, **[Yandex.Translate](https://translate.yandex.ru/)**, **[sodapng](https://github.com/sodapng)**, **[mynovelhost](https://github.com/mynovelhost)**, **[SashaXser](https://github.com/SashaXser)** and to all other contributors. Thanks <3

## Installing the extension:
Expand Down Expand Up @@ -49,7 +52,7 @@ You can see all the restrictions related to site support in [wiki](https://githu
- **[Bilibili](https://bilibili.com/)**
- **[Video Mail.ru](https://my.mail.ru/video)**
- **[Vimeo](https://vimeo.com/)**
- **[[⚠️] XVideos](https://xvideos.com/)**
- **[XVideos](https://xvideos.com/)**
- **[PornHub](https://rt.pornhub.com/)**
- **[Bitchute](https://www.bitchute.com/)**
- **[Coursera](https://www.coursera.org/)**
Expand All @@ -69,16 +72,12 @@ You can see all the restrictions related to site support in [wiki](https://githu
- **[Youku](https://youku.com)**
- **[Newgrounds](https://newgrounds.com)**
- **[ProxiTok](https://proxitok.pabloferreiro.es/)**
- **[[⚠️] Invidious](https://yewtu.be)**
- **[[⚠️] Piped](https://piped.video)**
- **[Invidious](https://yewtu.be)**
- **[Piped](https://piped.video)**
- **Any direct web links to `.mp4`**

⚠️ - Requires additional actions, more in **[Wiki](https://github.com/ilyhalight/voice-over-translation/wiki/%5BEN%5D-Supported-sites)**

❌ - Doesn't work

❔ - Yandex support may be disabled

## List of functionality:

1. Translation from one of the available languages into Russian. The language is detected automatically, if the language is not in the list or it was not possible to determine it, then a translation from English is used.
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
Закадровый перевод видео, теперь, доступен не только в YandexBrowser.
Очень признателен, **[Yandex.Translate](https://translate.yandex.ru/)**, **[sodapng](https://github.com/sodapng)**, **[mynovelhost](https://github.com/mynovelhost)**, **[SashaXser](https://github.com/SashaXser)** и всем остальным контрибьюторам. Спасиб <3

> [!WARNING]
> Если вы пользуетесь Tampermonkey 5.2.0+, не забудьте [включить](https://github.com/ilyhalight/voice-over-translation/issues/662#issuecomment-2160768958) режим разработчика или используйте Tampermonkey MV2
## Установка расширения:

1. Установите расширение **[Tampermonkey](https://www.tampermonkey.net/)** (Альтернатива для Safari: **[UserScripts](https://apps.apple.com/app/userscripts/id1463298887)**)
Expand Down Expand Up @@ -50,7 +53,7 @@
- **[Bilibili](https://bilibili.com/)**
- **[Видео Mail.ru](https://my.mail.ru/video)**
- **[Vimeo](https://vimeo.com/)**
- **[[⚠️] XVideos](https://xvideos.com/)**
- **[XVideos](https://xvideos.com/)**
- **[PornHub](https://rt.pornhub.com/)**
- **[Bitchute](https://www.bitchute.com/)**
- **[Coursera](https://www.coursera.org/)**
Expand All @@ -70,16 +73,12 @@
- **[Youku](https://youku.com)**
- **[Newgrounds](https://newgrounds.com)**
- **[ProxiTok](https://proxitok.pabloferreiro.es/)**
- **[[⚠️] Invidious](https://yewtu.be)**
- **[[⚠️] Piped](https://piped.video)**
- **[Invidious](https://yewtu.be)**
- **[Piped](https://piped.video)**
- **Любые прямые веб-ссылки на `.mp4`**

⚠️ - Требует дополнительных действий, подробнее в **[Wiki](https://github.com/ilyhalight/voice-over-translation/wiki/%5BRU%5D-Supported-sites)**

❌ - Не поддерживается

❔ - Возможно отключена поддержка со стороны Яндекса

## Список функционала:

1. Перевод с одного из доступных языков на русский. Язык определяется автоматически, если языка нету в списке или не удалось его определить, то используется перевод с английского.
Expand Down
Binary file modified bun.lockb
Binary file not shown.
3 changes: 3 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@

# 1.x

- Добавлена возможность выделения отдельных слов в субтитрах (#666)
- Добавлена поддержка VK Clips
- Добавлена поддержка YouTube Live (https://youtube.com/live/VIDEO_ID) (#657)
- Добавлена поддержка bitchute embed
- Обновлена логика получения айди для clips.twitch.tv. Добавлена поддержка не только встроенных (embed) клипов
- Исправлено неправильное формирование параметра запроса для weverse
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
],
"devDependencies": {
"ajv": "^8.13.0",
"bun-types": "^1.1.13",
"css-loader": "^7.1.1",
"eslint": "^8.57.0",
"eslint-config-prettier": "^9.1.0",
Expand Down Expand Up @@ -49,7 +50,8 @@
"lint": "npx eslint .",
"lint-fix": "npx eslint . --fix",
"format": "prettier --write --ignore-unknown \"src/**/*.{html,css,scss,cjs,js,ts,json}\"",
"prepare": "husky"
"prepare": "husky",
"gen:wiki": "bun run ./wiki/gen-sites.js"
},
"dependencies": {
"bowser": "^2.11.0",
Expand Down
10 changes: 10 additions & 0 deletions wiki/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Wiki scripts

Автогенерируемый markdown для Wiki.

Полностью автоматически обновляется, только, список сайтов. Все пути и ограничения должны быть прописаны вручную в `gen-sites.js`

### Запуск:

1. Установить [Bun](https://bun.sh)
2. Из корня (там где файл package.json) выполнить `bun gen:wiki`
Loading

0 comments on commit 51acf64

Please sign in to comment.