Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
billhennessy committed Jun 27, 2020
1 parent be010f8 commit da906cc
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Your local Hugo repo should now contain `video.html` and `audio.html`

Audio requires two arguments:

* path-to-audio with quotes `audio/my-voice-recording.mp3`
* path-to-audio with quotes `/audio/my-voice-recording.mp3`
* preload (auto | metadata | none)

Example:
Expand All @@ -51,13 +51,31 @@ Example:
```

!Important: remember the preceding `/` on file location.

Note: I use only `auto` to prevent skipping in Chrome browser.

The HTML audio tag works with `.mp3`, `.ogg`, and `.wav` files only.

### video.html

Coming Soon.
Currently supports only MP4.

Video requires four arguments:

* path-to-audio with quotes `/video/my-video.mp4`
* width in pixels
* height in pixels
* preload (auto | metadata | none)

Example:

```
{{< video "/video/my-video.mp4" 600 400 auto >}}
```

!Important: remember the preceding `/` on file location.



Expand Down

0 comments on commit da906cc

Please sign in to comment.