Skip to content

Commit

Permalink
Исправлено ReadMe доков
Browse files Browse the repository at this point in the history
  • Loading branch information
K1llMan committed May 9, 2023
1 parent b88ea1f commit 16b41da
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 18 deletions.
28 changes: 14 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
# История изменений

# 1.4.0
## 1.4.0
* Удалена авторизация по логину и паролю, как устаревшая.
* Классы API для удобства разбиты на асинхронную и синхронную части.
* Добавлены асинхронные методы-расширения.
* Добавлен асинхронный клиент (требует тестирования).
# 1.3.6
## 1.3.6
* Добавлены асинхронные методы для получения ссылки на файл, для сохранения, получения массива байт и потока.
* Актуализированы модели.
# 1.3.5
## 1.3.5
* Актуализированы модели.
# 1.3.4
## 1.3.4
* Добавлен тип Notification для сообщения ленты.
* Исправлена обработка ошибок десериализации.
* Актуализированы модели.
# 1.3.3
## 1.3.3
* Исправления для корректной работы с пользовательскими треками. ([PrepConcedeITIS](https://github.com/PrepConcedeITIS))
# 1.3.2
## 1.3.2
* Дополнены модели авторизации.
* Вынесен интерфейс IDebugWriter для реализации пользовательского отладочного логирования.
# 1.3.1
## 1.3.1
* Дополнен список методов авторизации YAuthMethod.
# 1.3.0
## 1.3.0
* API для работы c очередями. ([shuryak](https://github.com/shuryak))
* Актуализированы модели.
# 1.2.1
## 1.2.1
* Исправление авторизаций.
# 1.2.0
## 1.2.0
* Добавлены различные варианты авторизации. ([martin211](https://github.com/martin211))
# 1.1.1
## 1.1.1
* Актуализированы модели.
* Поддержка netstandard2.0.
# 1.1.0
## 1.1.0
* Актуализированы модели.
* Удалены ненужные async/await.
* Новый механизм описания запросов к API.
Expand All @@ -41,11 +41,11 @@
* Методы для получения похожих треков и дополнительной информации для трека.
* Методы для запроса списка треков, альбомов, исполнителей и плейлистов.
* На клиенте синхронизирован функционал с API, добавлены методы-расширения.
# 1.0.1
## 1.0.1
* Актуализированы модели.
* Исправлены ошибки десериализации поля Labels модели YAlbum.
* Рефакторинг под Net 5.0.
* Поиск по подкастам.
* При получении ссылки на трек выбирается версия с максимальным битрейтом.
# 1.0.0
## 1.0.0
Начальный коммит.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
import shutil
sys.path.insert(0, os.path.abspath('../..'))

# Copy resources
def copy_resources(app, docname):
if app.builder.name == 'html':
output_dir = os.path.join(app.outdir, 'src', 'Resources')
source_dir = os.path.join(app.srcdir, '..', '..', 'src', 'Resources')
if not os.path.exists(output_dir):
#os.makedirs(os.path.join(app.outdir, 'src', 'Resources'))
shutil.copytree(source_dir, output_dir)

def setup(app):
Expand Down
4 changes: 3 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
Документация неофициальной C# библиотеки для API и клиента Yandex Music
==================================================================

.. include:: readme.md
:parser: myst_parser.sphinx_

.. toctree::
readme
api/api
client/client
18 changes: 18 additions & 0 deletions docs/source/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# <img width="48" height="48" src="src/Resources/icon.png"> Yandex.Music API (Unofficial) for .Net

[![Nuget](https://img.shields.io/nuget/v/KM.Yandex.Music.Api?label=KM.Yandex.Music.Api)](https://www.nuget.org/packages/KM.Yandex.Music.Api/)
[![Nuget](https://img.shields.io/nuget/v/KM.Yandex.Music.Client?label=KM.Yandex.Music.Client)](https://www.nuget.org/packages/KM.Yandex.Music.Client/)

Изначально было форком [Yandex.Music API (Unofficial) for .Net Core](https://github.com/Winster332/Yandex.Music.Api), отсоединено по причине отсутствия поддержки родительского проекта и полном переписывании функционала библиотеки.

API переделано под работу с API официального приложения, подобно [API Yandex Music - неофициальная Python библиотека](https://github.com/MarshalX/yandex-music-api)

Проекты для API и клиента. Примеры использования можно посмотреть в тестах. Тесты для API и клиента запускаются одинаково.

[Telegram-чат](https://t.me/yandex_music_api)

```{include} ../../CHANGELOG.md
```

## LICENCE
[GNU General Public License v3.0](https://github.com/K1llMan/Yandex.Music.Api/blob/master/LICENSE)
2 changes: 0 additions & 2 deletions docs/source/readme.rst

This file was deleted.

0 comments on commit 16b41da

Please sign in to comment.