Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DamianMorozov committed Feb 3, 2025
1 parent d3cc6a0 commit 04f3344
Show file tree
Hide file tree
Showing 13 changed files with 85 additions and 26 deletions.
5 changes: 5 additions & 0 deletions Docs/CHANGELOG-RUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@

## [Нереализовано]

## [0.5.450] - 2025-01-31
### Изменено
- Обновлены NuGet пакеты
- Исправлены некоторые исключения в TgDownloaderConsole

## [0.5.440] - 2025-01-25
### Исправлено
- Исправлены проверки файлов для TgDownloaderDesktop
Expand Down
5 changes: 5 additions & 0 deletions Docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.5.450] - 2025-01-31
### Changed
- Updated NuGet packages
- Fixed some exceptions in TgDownloaderConsole

## [0.5.440] - 2025-01-25
### Fixed
- Fixed file checks for TgDownloaderDesktop
Expand Down
47 changes: 47 additions & 0 deletions Docs/RELEASES-RUS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Статистика скачиваний

- GitHub все релизы ![GitHub all releases](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/total?style=social)
- GitHub preview v0.5.440 ![GitHub preview v0.5.440](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.440/total?style=social)
- GitHub preview v0.5.430 ![GitHub preview v0.5.430](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.430/total?style=social)
- GitHub preview v0.5.410 ![GitHub preview v0.5.410](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.410/total?style=social)
- GitHub preview v0.5.370 ![GitHub preview v0.5.370](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.370/total?style=social)
- GitHub preview v0.5.360 ![GitHub preview v0.5.360](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.360/total?style=social)
- GitHub release v0.5.330 ![GitHub release v0.5.330](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.330/total?style=social)
- GitHub release v0.5.320 ![GitHub release v0.5.320](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.320/total?style=social)
- GitHub release v0.5.300 ![GitHub release v0.5.300](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.300/total?style=social)
- GitHub release v0.5.250 ![GitHub release v0.5.250](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.250/total?style=social)
- GitHub release v0.5.230 ![GitHub release v0.5.230](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.230/total?style=social)
- GitHub release v0.5.180 ![GitHub release v0.5.180](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.180/total?style=social)
- GitHub release v0.5.160 ![GitHub release v0.5.160](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.160/total?style=social)
- GitHub release v0.4.150 ![GitHub release v0.4.150](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.4.150/total?style=social)
- GitHub release v0.4.100 ![GitHub release v0.4.100](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.4.100/total?style=social)
- GitHub release v0.4.030 ![GitHub release v0.4.030](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.4.030/total?style=social)
- GitHub release v0.4.010 ![GitHub release v0.4.010](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.4.010/total?style=social)
- GitHub release v0.3.110 ![GitHub release v0.3.110](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.3.110/total?style=social)
- GitHub release v0.3.010 ![GitHub release v0.3.010](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.3.010/total?style=social)
- GitHub release v0.2.570 ![GitHub release v0.2.570](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.570/total?style=social)
- GitHub release v0.2.550 ![GitHub release v0.2.550](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.550/total?style=social)
- GitHub release v0.2.540 ![GitHub release v0.2.540](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.540/total?style=social)
- GitHub release v0.2.490 ![GitHub release v0.2.490](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.490/total?style=social)
- GitHub release v0.2.480 ![GitHub release v0.2.480](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.480/total?style=social)
- GitHub release v0.2.460 ![GitHub release v0.2.460](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.460/total?style=social)
- GitHub release v0.2.300 ![GitHub release v0.2.300](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.300/total?style=social)
- GitHub release v0.2.270 ![GitHub release v0.2.270](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.270/total?style=social)
- GitHub release v0.2.230 ![GitHub release v0.2.230](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.230/total?style=social)
- GitHub release v0.2.150 ![GitHub release v0.2.150](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.150/total?style=social)
- GitHub release v0.2.130 ![GitHub release v0.2.130](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.2.130/total?style=social)
- GitHub preview v0.1.720 ![GitHub preview v0.1.720](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.720/total?style=social)
- GitHub preview v0.1.710 ![GitHub preview v0.1.710](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.710/total?style=social)
- GitHub preview v0.1.700 ![GitHub preview v0.1.700](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.700/total?style=social)
- GitHub release v0.1.630 ![GitHub release v0.1.630](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.630/total?style=social)
- GitHub release v0.1.620 ![GitHub release v0.1.620](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.620/total?style=social)
- GitHub release v0.1.610 ![GitHub release v0.1.610](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.610/total?style=social)
- GitHub release v0.1.600 ![GitHub release v0.1.600](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.600/total?style=social)
- GitHub release v0.1.500 ![GitHub release v0.1.500](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.500/total?style=social)
- GitHub release v0.1.430 ![GitHub release v0.1.430](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.430/total?style=social)
- GitHub release v0.1.390 ![GitHub release v0.1.390](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.390/total?style=social)
- GitHub release v0.1.360 ![GitHub release v0.1.360](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.360/total?style=social)
- GitHub release v0.1.350 ![GitHub release v0.1.350](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.350/total?style=social)
- GitHub release v0.1.310 ![GitHub release v0.1.310](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.310/total?style=social)
- GitHub release v0.1.250 ![GitHub release v0.1.250](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.250/total?style=social)
- GitHub release v0.1.180 ![GitHub release v0.1.180](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.1.180/total?style=social)
5 changes: 1 addition & 4 deletions Docs/RELEASE.md → Docs/RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
# TgDownloader Release history

## <div align="center"><b><a href="../README.md">Readme</a> | <a href="../CHANGELOG.md">Changelog</a> | <a href="RELEASE.md">Releases</a> | <a href="SCREENSHOTS.md">Screenshots</a> | <a href="GUIDES.md">Guides</a></b></div>
## <div align="center"><b><a href="../README-RUS.md">Прочти меня</a> | <a href="../CHANGELOG-RUS.md">История версий</a> | <a href="RELEASE.md">Релизы</a> | <a href="SCREENSHOTS.md">Скриншоты</a> | <a href="GUIDES-RUS.md">Руководства</a></b></div>
# Download statistics

- GitHub all releases ![GitHub all releases](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/total?style=social)
- GitHub preview v0.5.440 ![GitHub preview v0.5.440](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.440/total?style=social)
Expand Down
3 changes: 2 additions & 1 deletion Presentation/TgDownloaderBlazor/TgDownloaderBlazor.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@
<None Include="..\..\Docs\GUIDES.md" Link="Docs\GUIDES.md" />
<None Include="..\..\Docs\ISSUE-RUS.md" Link="Docs\ISSUE-RUS.md" />
<None Include="..\..\Docs\ISSUE.md" Link="Docs\ISSUE.md" />
<None Include="..\..\Docs\RELEASE.md" Link="Docs\RELEASE.md" />
<None Include="..\..\Docs\RELEASES.md" Link="Docs\RELEASES.md" />
<None Include="..\..\Docs\RELEASES-RUS.md" Link="Docs\RELEASES-RUS.md" />
<None Include="..\..\Docs\RESOURCES-RUS.md" Link="Docs\RESOURCES-RUS.md" />
<None Include="..\..\Docs\RESOURCES.md" Link="Docs\RESOURCES.md" />
<None Include="..\..\Docs\SCREENSHOTS.md" Link="Docs\SCREENSHOTS.md" />
Expand Down
3 changes: 2 additions & 1 deletion Presentation/TgDownloaderConsole/TgDownloaderConsole.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@
</None>
<None Include="..\..\Docs\ISSUE-RUS.md" Link="Docs\ISSUE-RUS.md" />
<None Include="..\..\Docs\ISSUE.md" Link="Docs\ISSUE.md" />
<None Include="..\..\Docs\RELEASE.md" Link="Docs\RELEASE.md" />
<None Include="..\..\Docs\RELEASES-RUS.md" Link="Docs\RELEASES-RUS.md" />
<None Include="..\..\Docs\RELEASES.md" Link="Docs\RELEASES.md" />
<None Include="..\..\Docs\RESOURCES-RUS.md" Link="Docs\RESOURCES-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@
<value>Release history</value>
</data>
<data name="SettingsPage_Release_History.Tag" xml:space="preserve">
<value>"https://github.com/DamianMorozov/TgDownloader/blob/main/Docs/RELEASE.md"</value>
<value>"https://github.com/DamianMorozov/TgDownloader/blob/main/Docs/RELEASES.md"</value>
</data>
<data name="SettingsPage_GitHub_DockerConsole.Content" xml:space="preserve">
<value>TgDownloaderConsole Docker image</value>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@
<value>История релизов</value>
</data>
<data name="SettingsPage_Release_History.Tag" xml:space="preserve">
<value>"https://github.com/DamianMorozov/TgDownloader/blob/main/Docs/RELEASE.md"</value>
<value>"https://github.com/DamianMorozov/TgDownloader/blob/main/Docs/RELEASES-RUS.md"</value>
</data>
<data name="SettingsPage_GitHub_DockerConsole.Content" xml:space="preserve">
<value>TgDownloaderConsole Докер образ</value>
Expand Down
5 changes: 2 additions & 3 deletions Presentation/TgDownloaderDesktop/TgDownloaderDesktop.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,8 @@
<None Include="..\..\Docs\ISSUE.md" Link="Docs\ISSUE.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\RELEASE.md" Link="Docs\RELEASE.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\RELEASES-RUS.md" Link="Docs\RELEASES-RUS.md" />
<None Include="..\..\Docs\RELEASES.md" Link="Docs\RELEASES.md" />
<None Include="..\..\Docs\RESOURCES-RUS.md" Link="Docs\RESOURCES-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
<None Include="..\..\Docs\GUIDES.md" Link="Docs\GUIDES.md" />
<None Include="..\..\Docs\ISSUE-RUS.md" Link="Docs\ISSUE-RUS.md" />
<None Include="..\..\Docs\ISSUE.md" Link="Docs\ISSUE.md" />
<None Include="..\..\Docs\RELEASE.md" Link="Docs\RELEASE.md" />
<None Include="..\..\Docs\RELEASES.md" Link="Docs\RELEASES.md" />
<None Include="..\..\Docs\RELEASES-RUS.md" Link="Docs\RELEASES-RUS.md" />
<None Include="..\..\Docs\RESOURCES-RUS.md" Link="Docs\RESOURCES-RUS.md" />
<None Include="..\..\Docs\RESOURCES.md" Link="Docs\RESOURCES.md" />
<None Include="..\..\Docs\SCREENSHOTS.md" Link="Docs\SCREENSHOTS.md" />
Expand Down
13 changes: 7 additions & 6 deletions README-RUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

## Глобальная версия
### <div align="center"><b><a href="http://tgdownloader.online">tgdownloader.online</a> | <a href="http://tg-downloader.online">tg-downloader.online</a></b></div>
### <div align="center"><b><a href="README.md">Readme</a> | <a href="CHANGELOG.md">Changelog</a> | <a href="Docs/RELEASE.md">Releases</a></b></div>
### <div align="center"><b><a href="README.md">Readme</a> | <a href="CHANGELOG.md">Changelog</a> | <a href="Docs/RELEASES.md">Download statistics</a></b></div>
### <div align="center"><b><a href="Docs/SCREENSHOTS.md">Screenshots</a> | <a href="Docs/GUIDES.md">Guides</a> | <a href="LICENSE.md">License</a></b></div>

## Русская версия
### <div align="center"><b><a href="http://tgdownloader.ru">tgdownloader.ru</a> | <a href="http://tg-downloader.ru">tg-downloader.ru</a></b></div>
### <div align="center"><b><a href="README-RUS.md">Прочти меня</a> | <a href="CHANGELOG-RUS.md">История версий</a> | <a href="Docs/RELEASE.md">Релизы</a></b></div>
### <div align="center"><b><a href="README-RUS.md">Прочти меня</a> | <a href="CHANGELOG-RUS.md">История версий</a> | <a href="Docs/RELEASES-RUS.md">Статистика скачиваний</a></b></div>
### <div align="center"><b><a href="Docs/SCREENSHOTS.md">Скриншоты</a> | <a href="Docs/GUIDES-RUS.md">Руководства</a> | <a href="LICENSE.md">Лицензия</a></b></div>

## Статистика о проекте
Expand All @@ -34,15 +34,15 @@
- [Новости](https://t.me/TgDownloader)
- [Русскоязычный чат](https://t.me/TgDownloaderChatRus)

## Docker образы
## Docker
- [TgDownloaderConsole Докер образ](https://hub.docker.com/repository/docker/damianmorozov/tgdownloader-console)

## Требования к установке
- [Скачать .NET 9.0](https://dotnet.microsoft.com/ru-ru/download/dotnet/9.0)
- [Зарегистрируйте Telegram приложение](https://my.telegram.org/apps)
- Сохраните значения полей "App api_id" и "App api_hash"
- Сохраните значения полей секции `App configuration`: `App api_id` / `App api_hash`

## Поддержка проекта
<details>
<summary><b>Поддержка проекта</b></summary>
- [Звёздочка ГитХаб](https://github.com/DamianMorozov/TgDownloader)
- [Донат через Бусти](https://boosty.to/tgdownloader)
- Донат через USDT TRC20: TBTDRWnMBw7acfpkhAXjSQNSNHQGFR662Y
Expand All @@ -55,3 +55,4 @@
- Донат через X Empire: UQBkjSs3XPmraI_sS4Mf05SMd1y44DahNhwPg9ySp3V-M3N6
- Донат через Catizen: UQBkjSs3XPmraI_sS4Mf05SMd1y44DahNhwPg9ySp3V-M3N6
- Донат через Major: UQBkjSs3XPmraI_sS4Mf05SMd1y44DahNhwPg9ySp3V-M3N6
</details>
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Global version
### <div align="center"><b><a href="http://tgdownloader.online">tgdownloader.online</a> | <a href="http://tg-downloader.online">tg-downloader.online</a></b></div>
### <div align="center"><b><a href="README.md">Readme</a> | <a href="Docs/CHANGELOG.md">Changelog</a> | <a href="Docs/RELEASE.md">Releases</a></b></div>
### <div align="center"><b><a href="README.md">Readme</a> | <a href="Docs/CHANGELOG.md">Changelog</a> | <a href="Docs/RELEASES.md">Download statistics</a></b></div>
### <div align="center"><b><a href="Docs/SCREENSHOTS.md">Screenshots</a> | <a href="Docs/GUIDES.md">Guides</a> | <a href="LICENSE.md">License</a></b></div>

## Russian version
### <div align="center"><b><a href="http://tgdownloader.ru">tgdownloader.ru</a> | <a href="http://tg-downloader.ru">tg-downloader.ru</a></b></div>
## <div align="center"><b><a href="README-RUS.md">Прочти меня</a> | <a href="Docs/CHANGELOG-RUS.md">История версий</a> | <a href="Docs/RELEASE.md">Релизы</a></b></div>
## <div align="center"><b><a href="Docs/SCREENSHOTS.md">Скриншоты</a> | <a href="Docs/GUIDES-RUS.md">Руководства</a> | <a href="LICENSE.md">Лицензия</a></b></div>
### <div align="center"><b><a href="README-RUS.md">Прочти меня</a> | <a href="Docs/CHANGELOG-RUS.md">История версий</a> | <a href="Docs/RELEASES-RUS.md">Статистика скачиваний</a></b></div>
### <div align="center"><b><a href="Docs/SCREENSHOTS.md">Скриншоты</a> | <a href="Docs/GUIDES-RUS.md">Руководства</a> | <a href="LICENSE.md">Лицензия</a></b></div>

## Statistics about the project
![GitHub releases](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/total?style=social)
Expand All @@ -34,15 +34,15 @@ The desktop version is in active development stage (preview).
- [News](https://t.me/TgDownloader)
- [Global Chat](https://t.me/TgDownloaderChat)

## Docker images
## Docker
- [TgDownloaderConsole Docker image](https://hub.docker.com/repository/docker/damianmorozov/tgdownloader-console)

## Install Requirements
- [Download .NET 9.0](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
- [Register Telegram app](https://my.telegram.org/apps)
- Save the values of the "App api_id" and "App api_hash" fields
- Save the values of the fields by `App configuration` section: `App api_id` / `App api_hash`

## Project support
<details>
<summary><b>Project support</b></summary>
- [GitHub star](https://github.com/DamianMorozov/TgDownloader)
- [Donate through Boosty](https://boosty.to/tgdownloader)
- Donate through USDT TRC20: TBTDRWnMBw7acfpkhAXjSQNSNHQGFR662Y
Expand All @@ -55,3 +55,4 @@ The desktop version is in active development stage (preview).
- Donate through X Empire: UQBkjSs3XPmraI_sS4Mf05SMd1y44DahNhwPg9ySp3V-M3N6
- Donate through Catizen: UQBkjSs3XPmraI_sS4Mf05SMd1y44DahNhwPg9ySp3V-M3N6
- Donate through Major: UQBkjSs3XPmraI_sS4Mf05SMd1y44DahNhwPg9ySp3V-M3N6
</details>
3 changes: 2 additions & 1 deletion TgDownloader.sln
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{49FCA776-C
Docs\ISSUE-RUS.md = Docs\ISSUE-RUS.md
Docs\ISSUE.md = Docs\ISSUE.md
LICENSE.md = LICENSE.md
Docs\RELEASE.md = Docs\RELEASE.md
Docs\RELEASES-RUS.md = Docs\RELEASES-RUS.md
Docs\RELEASES.md = Docs\RELEASES.md
Docs\RESOURCES-RUS.md = Docs\RESOURCES-RUS.md
Docs\RESOURCES.md = Docs\RESOURCES.md
Docs\SCREENSHOTS.md = Docs\SCREENSHOTS.md
Expand Down

0 comments on commit 04f3344

Please sign in to comment.