diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dcf70cd..5abb4a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,13 @@ ## Fixes -When your contribution fixes an issue or any incorrect behaviour feel free to place a pull request, -its highly appreciated. +When your contribution fixes an issue or any incorrect behaviour feel free to place a pull request. +Its highly appreciated! ## Features When contributing to this repository, in form of a feature, please first discuss the change you wish -to make through creating an issue. Also see the planned features pointed out in the readme. +to make through creating an issue or on discussions. --- diff --git a/README.md b/README.md index 1c7317e..181be81 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Maven Central release +
Functionality Test State @@ -25,36 +26,39 @@ ## What is it ? -TrackSearch is for searching track metadata on different sources, like Youtube and SoundCloud for now and to expose the -URL of the underlying audio stream in the highest resolution. That offers the possibility to hand them over to other -programs which are able to process them, like [VLC](https://www.videolan.org/vlc/), or Firefox which can display the -audio directly for example. +*TrackSearch* is for searching track metadata on different sources, like *YouTube* and *SoundCloud* for now and to +expose the URL of the underlying (audio) stream with the best quality. That offers the possibility to hand them over +to other programs which are able to process them, like [VLC](https://www.videolan.org/vlc/), or *Firefox* which can +display (most) streams directly, for example. **Note:** TrackSearch isn't using any API-Key, it uses the public API (like your browser). ## Supported sources Since TrackSearch focuses on just exposing the audio streams and to search for music (although YouTube offers more than -music) I decided to add following providers first for now: +music) I decided to add following providers for now: -- YouTube -- SoundCloud +![youtube](https://img.shields.io/badge/-YouTube-FF0000?style=plastic&logo=youtube&logoColor=white) +![soundcloud](https://img.shields.io/badge/-SoundCloud-FF3300?style=plastic&logo=soundcloud&logoColor=white) -There could be more added if there is interesting content offered to go for. +There could be more added if there are interesting sources to go for. + +**Note:** Those sources are accessed vie the public API without the use of any API key or similar. #### Current features :mag_right: -- Search for keywords -- Paging of track lists -- Expose audio stream url -- Interact with multiple clients asynchronous -- Get track metadata like: duration, channel, views, thumbnail, ... +- search +- paging +- (audio) stream url +- format +- multiple clients asynchronous +- metadata like: duration, channel, views, thumbnail, ... ## How to use it ? :books: ### Dependency -Maven dependency available on [Maven Central](https://search.maven.org/artifact/io.sfrei/tracksearch): +*TrackSearch* is available on [Maven Central](https://search.maven.org/artifact/io.sfrei/tracksearch): ```xml @@ -64,8 +68,12 @@ Maven dependency available on [Maven Central](https://search.maven.org/artifact/ ``` -or from [GitHub Packages](https://github.com/s-frei/TrackSearch/packages) or directly from -[GitHub Releases](https://github.com/s-frei/TrackSearch/releases). +```kotlin +implementation("io.sfrei:tracksearch:0.9.0") +``` + +on [GitHub Packages](https://github.com/s-frei/TrackSearch/packages) or directly from +[GitHub Releases](https://github.com/s-frei/TrackSearch/releases/latest). ### Getting started @@ -89,7 +97,7 @@ try { TrackList nextTracks = tracksForSearch.next(); // Get a track for URL - Track trackForURL = explicitClient.getTrack(""); + SoundCloudTrack trackForURL = explicitClient.getTrack(""); } catch (TrackSearchException e) { // Damn @@ -136,8 +144,3 @@ $ ./mvnw test -P detailed-client-test ## Contributing :handshake: Feel free to contribute! - [How?](https://github.com/s-frei/TrackSearch/blob/develop/CONTRIBUTING.md) - -#### Stuff to be added - -- Direct audio stream URL resolving -- Playlist URL search