Skip to content

docs: update README documentation URLs #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
athphane wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update README documentation URLs #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
344e67d
docs: update README documentation URLs
athphane Oct 10, 2026
b7e153e
docs: update visible documentation URL label
athphane Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
[![Coverage](https://raw.githubusercontent.com/Javaabu/dhivehigpt-player-js/main/badges/coverage.svg)](https://github.com/Javaabu/dhivehigpt-player-js/actions/workflows/tests.yml)
[![License](https://img.shields.io/npm/l/%40javaabu%2Fdhivehigpt-player.svg)](LICENSE.md)

A lightweight, dependency-free audio player for [DhivehiGPT](https://dhivehigpt.com)-generated "read aloud" audio. Turns a plain `<audio>` tag into a branded control bar, embeddable on any website — no build step required. Built for modern evergreen browsers (Safari 10.1+/Chrome 58+/Firefox 52+/Edge 15+ — see [requirements](https://docs.javaabu.com/docs/dhivehigpt-player-js/requirements)).
A lightweight, dependency-free audio player for [DhivehiGPT](https://dhivehigpt.com)-generated "read aloud" audio. Turns a plain `<audio>` tag into a branded control bar, embeddable on any website — no build step required. Built for modern evergreen browsers (Safari 10.1+/Chrome 58+/Firefox 52+/Edge 15+ — see [requirements](https://docs.javaabu.com/dhivehigpt-player-js/requirements)).

**[Live demo](https://javaabu.github.io/dhivehigpt-player-js/)**

## Documentation

Full documentation: **[docs.javaabu.com/docs/dhivehigpt-player-js](https://docs.javaabu.com/docs/dhivehigpt-player-js)**
Full documentation: **[docs.javaabu.com/dhivehigpt-player-js](https://docs.javaabu.com/dhivehigpt-player-js)**

Find yourself stuck using the package? Found a bug? Feel free to create an [issue](../../issues) on GitHub, we'll try to address it as soon as possible.

Expand Down Expand Up @@ -39,7 +39,7 @@ Add `data-dhivehigpt-player` to a standard `<audio>` tag — it's converted auto
<audio data-dhivehigpt-player src="https://example.com/article.mp3"></audio>
```

Options are set via `data-*` attributes, e.g. `data-dark="true"`, `data-accent="true"`, `data-sticky="true"`. See the [data-attributes reference](https://docs.javaabu.com/docs/dhivehigpt-player-js/modules/data-attributes) for the full list.
Options are set via `data-*` attributes, e.g. `data-dark="true"`, `data-accent="true"`, `data-sticky="true"`. See the [data-attributes reference](https://docs.javaabu.com/dhivehigpt-player-js/modules/data-attributes) for the full list.

Or initialize programmatically:

Expand All @@ -50,7 +50,7 @@ const player = new AudioPlayer('#my-audio', { accent: true, sticky: true });
player.on('play', () => console.log('playing'));
```

React, Vue, Svelte, and jQuery integrations are available at `@javaabu/dhivehigpt-player/react`, `/vue`, `/svelte`, and `/jquery` (each a separate entry, so the core bundle only ships what you actually use). Angular, Alpine.js, and Laravel Livewire are supported too — see the [framework guides](https://docs.javaabu.com/docs/dhivehigpt-player-js) for details.
React, Vue, Svelte, and jQuery integrations are available at `@javaabu/dhivehigpt-player/react`, `/vue`, `/svelte`, and `/jquery` (each a separate entry, so the core bundle only ships what you actually use). Angular, Alpine.js, and Laravel Livewire are supported too — see the [framework guides](https://docs.javaabu.com/dhivehigpt-player-js) for details.

## Changelog

Expand Down
Loading