Skip to content

Commit

Permalink
πŸ“ (readme) update docs url
Browse files Browse the repository at this point in the history
  • Loading branch information
Tahul committed Feb 20, 2021
1 parent 71057ea commit 20cba52
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -2,7 +2,7 @@

[![npm](https://img.shields.io/npm/v/@vueuse/sound.svg)](https://www.npmjs.com/package/@vueuse/sound)
[![npm](https://img.shields.io/npm/dm/@vueuse/sound.svg)](https://npm-stat.com/charts.html?package=@vueuse/sound)
[![Netlify Status](https://api.netlify.com/api/v1/badges/991aafcb-635a-457d-93a4-10f4b895c8c5/deploy-status)](https://app.netlify.com/sites/vue-use-sound/deploys)
[![Netlify Status](https://api.netlify.com/api/v1/badges/991aafcb-635a-457d-93a4-10f4b895c8c5/deploy-status)](https://app.netlify.com/sites/vueuse-sound/deploys)

- πŸ‘‚ Lets your website **communicate** using 2 **human senses** instead of 1
- πŸ”₯ Built with **Vue** Composition API
Expand All @@ -12,7 +12,7 @@
- ✨ Built with **TypeScript**
- πŸ—£ Uses a powerful, battle-tested audio utility: [**Howler.js**](https://howlerjs.com/)

If you want to take a **quick look** at the composable in effect, you should visit the [🌍 **demo**](https://vue-use-sound.netlify.app).
If you want to take a **quick look** at the composable in effect, you should visit the [🌍 **demo**](https://vueuse-sound.netlify.app).

This package is a **Vue** version of the [**useSound**](https://github.com/joshwcomeau/use-sound) React hook by [**joshwcomeau**](https://github.com/joshwcomeau).

Expand Down Expand Up @@ -59,11 +59,11 @@ export default {

### Playing on hover

This example is shown in the [demo](https://vue-use-sound.netlify.app#hover).
This example is shown in the [demo](https://vueuse-sound.netlify.app#hover).

### Increase pitch on every click

This example is shown in the [demo](https://vue-use-sound.netlify.app#pitch).
This example is shown in the [demo](https://vueuse-sound.netlify.app#pitch).

## Usage Notes

Expand Down Expand Up @@ -178,7 +178,7 @@ const [play, exposedData] = useSound('/meow.mp3')

An audio sprite is a single audio file that holds multiple samples. Instead of loading many individual sounds, you can load a single file and slice it up into multiple sections which can be triggered independently.

> There can be a performance benefit to this, since it's less parallel network requests, but it can also be worth doing this if a single component needs multiple samples. See the [Drum Machine component](https://vue-use-sound.netlify.app#drums) for an example.
> There can be a performance benefit to this, since it's less parallel network requests, but it can also be worth doing this if a single component needs multiple samples. See the [Drum Machine component](https://vueuse-sound.netlify.app#drums) for an example.
For sprites, we'll need to define a `SpriteMap`. It looks like this:

Expand Down

0 comments on commit 20cba52

Please sign in to comment.