From 0a589d9c643f765f3f381f74613a061b1b1b5109 Mon Sep 17 00:00:00 2001 From: Lars Noack Date: Tue, 7 May 2024 11:15:20 +0200 Subject: [PATCH] feat: added links to wiki --- README.md | 39 +++------------------------------------ 1 file changed, 3 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 70c7c74..3701ef5 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,10 @@ - [Installation](#installation) - [Quick-Guide](#quick-guide) - [How to search properly](#query) -- [CONTRIBUTE](#contribute) - [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 @@ -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 music-kraken logo @@ -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.** ---- - -# 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 [i2]: https://github.com/HeIIow2/music-downloader/issues/2