Browse Source

Expand Readme, add screenshot.

Gerben 4 years ago
2 changed files with 28 additions and 15 deletions
  1. +28
  2. BIN

+ 28
- 15 View File

@@ -1,26 +1,39 @@
# Bookmark audio fragment

Browser extension to bookmark fragments of audio files.
Browser extension to bookmark (or link to) fragments of audio files.


## Contribute

This project uses [webextension-toolbox]( for building/bundling the source code. It provides the following commands:
## Status

### Install
Proof-of-concept. Currently only usable for small files.

$ npm install

### Development
## Description

npm run dev chrome
npm run dev firefox
npm run dev opera
npm run dev edge
This extension replaces the browser’s default audio player interface with one that allows selecting any segments of the track and bookmarking them.

### Build
To try it out, open an audio file in the browser (ensure it is not configured to open audio in an external application), click and drag over a part of the visualisation of the track, then right-click to open the menu, and choose to bookmark the selected segment.

npm run build chrome
npm run build firefox
npm run build opera
npm run build edge
You can also copy a link to a segment to share it with others. Most browsers can read such links and will jump to the chosen spot in the track, because this extension uses the standard way to specify media fragments.

As an example, a link would look like `,15.5`; which points at the segment from 10 seconds up to 15 and a half seconds into the track.

## Install

The extension is available for Firefox and Chromium/Chrome/Brave/etc.

For Firefox and its derivatives, find it [on Mozilla Addons][].

To install it on a Chromium-based browser, download the ‘…’ file from the [releases][] page, open `about:extensions`, turn on developer mode, then drag the zip file onto that page.

## Develop

This project uses [webextension-toolbox]( for building/bundling the source code. Look there for details about how to bundle the extension.

[on Mozilla Addons]:

screenshot.png View File

Before After
Width: 2047  |  Height: 608  |  Size: 66 KiB