feat: added links to wiki
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
This commit is contained in:
parent
8abb89ea48
commit
0a589d9c64
39
README.md
39
README.md
@ -7,8 +7,10 @@
|
|||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Quick-Guide](#quick-guide)
|
- [Quick-Guide](#quick-guide)
|
||||||
- [How to search properly](#query)
|
- [How to search properly](#query)
|
||||||
- [CONTRIBUTE](#contribute)
|
|
||||||
- [Matrix Space](#matrix-space)
|
- [Matrix Space](#matrix-space)
|
||||||
|
|
||||||
|
If you want to use this a library or contribute, check out [the wiki](https://gitea.elara.ws/music-kraken/music-kraken-core/wiki) for more information.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
@ -67,10 +69,6 @@ The escape character is as usual `\`.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Contribute
|
|
||||||
|
|
||||||
I am happy about every pull request. To contribute look [here](contribute.md).
|
|
||||||
|
|
||||||
## Matrix Space
|
## Matrix Space
|
||||||
|
|
||||||
<img align="right" alt="music-kraken logo" src="assets/element_logo.png" width=100>
|
<img align="right" alt="music-kraken logo" src="assets/element_logo.png" width=100>
|
||||||
@ -79,37 +77,6 @@ I decided against creating a discord server, due to various communities get ofte
|
|||||||
|
|
||||||
**Click [this invitation](https://matrix.to/#/#music-kraken:matrix.org) _([https://matrix.to/#/#music-kraken:matrix.org](https://matrix.to/#/#music-kraken:matrix.org))_ to join.**
|
**Click [this invitation](https://matrix.to/#/#music-kraken:matrix.org) _([https://matrix.to/#/#music-kraken:matrix.org](https://matrix.to/#/#music-kraken:matrix.org))_ to join.**
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Programming Interface / Use as Library
|
|
||||||
|
|
||||||
This application is $100\%$ centered around Data. Thus, the most important thing for working with musik kraken is, to understand how I structured the data.
|
|
||||||
|
|
||||||
## Quick Overview
|
|
||||||
|
|
||||||
- explanation of the [Data Model](#data-model)
|
|
||||||
- how to use the [Data Objects](#data-objects)
|
|
||||||
- further Dokumentation of _hopefully_ [most relevant classes](documentation/objects.md)
|
|
||||||
- the [old implementation](documentation/old_implementation.md)
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
---
|
|
||||||
title: Quick Overview (outdated)
|
|
||||||
---
|
|
||||||
sequenceDiagram
|
|
||||||
|
|
||||||
participant pg as Page (eg. YouTube, MB, Musify, ...)
|
|
||||||
participant obj as DataObjects (eg. Song, Artist, ...)
|
|
||||||
participant db as DataBase
|
|
||||||
|
|
||||||
obj ->> db: write
|
|
||||||
db ->> obj: read
|
|
||||||
|
|
||||||
pg -> obj: find a source for any page, for object.
|
|
||||||
obj -> pg: add more detailed data from according page.
|
|
||||||
obj -> pg: if available download audio to target.
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
[i10]: https://github.com/HeIIow2/music-downloader/issues/10
|
[i10]: https://github.com/HeIIow2/music-downloader/issues/10
|
||||||
[i2]: https://github.com/HeIIow2/music-downloader/issues/2
|
[i2]: https://github.com/HeIIow2/music-downloader/issues/2
|
||||||
|
Loading…
Reference in New Issue
Block a user