Skip to content

Commit

Permalink
Update README.md - add live radio
Browse files Browse the repository at this point in the history
  • Loading branch information
ivandotv authored Dec 23, 2024
1 parent 8eca913 commit 1c9e7b5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ It simplifies the task of querying the API by creating methods for each API rout

I suggest you familiarize yourself with the [original API docs](https://de1.api.radio-browser.info/) before using this library.

Also note that this library modifies the results from the API, because the API is brittle, in a way that returns duplicate stations, duplicated tags, or tags that are not tags rather, complete sentences. The library cleans this up for you.
Also note that this library modifies the results from the API, because the API is brittle, in a way that returns duplicate stations, duplicated tags, or tags that are not tags but rather, complete sentences. The library will clean this up for you.

API by default, returns `broken` stations (stations that are in the system but don't have their streams up and running) library by default hides those stations ( this can be changed when creating the library instance, or per API call)

For an example of usage of this library check [live radio repository](https://github.com/ivandotv/live-radio)

## Usage

If using in node.js environment, make sure you have a fetch implementation (e.g [node-fetch](https://www.npmjs.com/package/node-fetch)) available. You should also have an application name that is going to be passed as `user agent string` when talking to the API. You can use whatever you like but be consistent, the author of the API uses it to track usage statistics.
Expand Down

0 comments on commit 1c9e7b5

Please sign in to comment.