forked from
tokono.ma/diffuse
A music player that connects to your cloud/distributed storage.
chore: readme update
+8
-10
+8
-10
README.md
+8
-10
README.md
···
1
-
<img src="https://diffuse.sh/images/diffuse-light.svg" alt="Diffuse" width="158" />
1
+
# Diffuse
2
2
3
-
**Construct your audio player**, make a music player and browser by composing web components.
3
+
**Construct your audio player by composing web components.**
4
4
5
5
Diffuse provides a range of custom elements: audio input, data output, metadata & artwork processing, audio playback, a queue system, and much more.
6
6
···
11
11
12
12
## Developer usage
13
13
14
-
You can either consume the Diffuse library via the [deployed instance](https://elements.diffuse.sh/latest/) (the listed elements link to Javascript files) or the [Javascript package](https://jsr.io/@toko/diffuse).
15
-
16
-
From there you can use the custom elements as with any other custom DOM element, by writing HTML or creating a `Class` instance.
14
+
You can either consume the Diffuse library via the [deployed instance](https://elements.diffuse.sh/latest/) (the listed elements link to Javascript files) or the [Javascript package](https://jsr.io/@toko/diffuse). From there you can use the custom elements as with any other custom DOM element, by writing HTML or creating a `Class` instance.
17
15
18
16
```html
19
-
<script src="https://elements.diffuse.sh/bafybeiezh4rgv7gk73o5dalfyilv5nfopezyvshtj5j7hrn23r4n27k7da/components/engine/queue/element.js"></script>
17
+
<script src="https://elements.diffuse.sh/bafybeiexuhqumeljxdmmsdfet5oh2h7pam6fy7gbktqfbsai5qfu2ze6hq/components/engine/queue/element.js"></script>
20
18
21
19
<de-queue></de-queue>
22
20
```
···
33
31
34
32
## Build it yourself
35
33
36
-
Install [deno](https://docs.deno.com/runtime/getting_started/installation/).
34
+
Install [Deno](https://docs.deno.com/runtime/getting_started/installation/).
37
35
38
36
```shell
39
37
deno run gen:defs:types
40
-
deno run build # or deno run build
38
+
deno run build # or deno run serve
41
39
```
42
40
43
41
Diffuse is built with:
44
42
- [Deno](https://deno.com)
45
43
- Web components (custom elements)
46
44
- Web workers (also: shared + service workers)
47
-
- Signals (currently alien-signals, but hopefully [TC39](https://github.com/tc39/proposal-signals) in the future)
45
+
- Signals (currently [alien-signals](https://github.com/stackblitz/alien-signals), but hopefully [TC39](https://github.com/tc39/proposal-signals) in the future)
48
46
- [`lit-html`](https://lit.dev/docs/libraries/standalone-templates/)
49
47
- [`music-metadata`](https://github.com/Borewit/music-metadata)
50
-
- Lume & ESBuild
48
+
- [Lume](https://lume.land) & [ESBuild](https://esbuild.github.io)