Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Henry Gressmann <mail@henrygressmann.de>
  • Loading branch information
explodingcamera committed Aug 26, 2024
1 parent 59040d1 commit 3dbfed4
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Subsonic-API <a href="https://www.npmjs.com/package/subsonic-api"><img src="https://img.shields.io/npm/v/subsonic-api?style=flat&colorA=000000&colorB=efefef"/></a> <a href="https://github.com/explodingcamera/subsonic-api/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/explodingcamera/subsonic-api/test.yml?branch=main&style=flat&colorA=000000"/></a>

A simple API library for interacting with Subsonic/Opensubsonic-compatible servers written in TypeScript. Supports Node.js >= 18, bun >= 1 and modern Browsers. 3kb minified and gzipped.
A lightweight Subsonic/Opensubsonic Client written in TypeScript. Supports Node, Deno, Bun, and modern Browsers.

## Features

- Supports all Subsonic API methods up to version 1.16.1 / Subsonic 6.1.4.
- Supports most of OpenSubsonic's new API methods.
- Supports both GET and POST requests.

## Installation

```bash
$ npm install subsonic-api # or
$ bun add subsonic-api
$ npm install subsonic-api # npm
$ bun add subsonic-api # bun
```

```html
<script type="module">
import { SubsonicAPI } from "https://esm.sh/subsonic-api";
</script>
```

## Example Usage
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"types": "lib/index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/explodingcamera/subsonic-api.git"
"url": "git+https://github.com/explodingcamera/subsonic-api.git"
},
"keywords": ["subsonic", "api", "music", "streaming", "media", "player", "client", "typescript"],
"homepage": "https://github.com/explodingcamera/subsonic-api",
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { arrayBufferToBase64 } from "./utils.js";
import { md5 } from "./md5";
import { md5 } from "./md5.js";

// biome-ignore format:
import type { AlbumID3, AlbumInfo, AlbumList, AlbumList2, ArtistInfo, ArtistInfo2, ArtistWithAlbumsID3, ArtistsID3, Bookmarks, ChatMessages, Directory, Genres, Indexes, InternetRadioStations, License, MusicFolders, NewestPodcasts, NowPlaying, OpenSubsonicExtensions, PlayQueue, Playlist, Playlists, Podcasts, ScanStatus, SearchResult2, SearchResult3, Shares, SimilarSongs, SimilarSongs2, Songs, Starred, Starred2, StructuredLyrics, TopSongs, User, Users, VideoInfo, Videos } from "./types.js";
Expand Down

0 comments on commit 3dbfed4

Please sign in to comment.