Verified Commit 501dfefd authored by Rigel Kent's avatar Rigel Kent
Browse files

📝 adding precisions on how to edit the description in the README

parent b5456c2c
# PeerTube plugin Quickstart
# Slides
Display images of your slides alongside a video, at specific timestamps. Ideal for conferences and presentations where resources add meaning to the video.
## How to use it
Edit the description of the video to have at least a `slides` block as follows:
```markdown
__slides__
- 00:30 https://your_first_slide.png
- 00:50 https://your_second_slide.jpeg
```
In addition you can add a `resources` block that will point users to documents (generally the slides deck as `.pdf`):
```markdown
__resources__
- Name or description of your file https://your_file.pdf
```
If no `sildes` block is found, the plugin doesn't activate and the video player doesn't get modified.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment