From a6b16ac3b2beafacd4b8e09afc63b581f347a512 Mon Sep 17 00:00:00 2001
From: James J Balamuta <james.balamuta@gmail.com>
Date: Mon, 22 Apr 2024 23:24:30 -0700
Subject: [PATCH] Add usage instructions to homepage

---
 docs/index.qmd | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/docs/index.qmd b/docs/index.qmd
index 6167c11..35748ce 100644
--- a/docs/index.qmd
+++ b/docs/index.qmd
@@ -6,3 +6,39 @@ format:
 ---
 
 The `embedio` shortcode extension allows you to incorporate different file types into Quarto HTML documents by using Quarto's shortcode mechanism.
+
+## Installation
+
+To install the `embedio` shortcode extension, follow these steps:
+
+1. Open your terminal.
+
+2. Execute the following command:
+
+```bash
+quarto add coatless-quarto/embedio
+```
+
+This command will download and install the shortcode extension under the `_extensions` subdirectory of your Quarto project. If you are using version control, ensure that you include this directory in your repository.
+
+## Usage
+
+We presently support the following shortcodes:
+
+| Shortcode  | Description                                                     |
+|------------|-----------------------------------------------------------------|
+| [`audio`](qembedio-embed-audio.qmd)    | Embeds an audio player with optional caption and download link. |
+| [`pdf`](qembedio-embed-pdf.qmd)      | Embeds a PDF file with customizable width and height.           |
+| [`revealjs`](qembedio-embed-revealjs.qmd) | Embeds a Reveal.js slide deck with optional height.             |
+
+You can use the shortcode immediately in a Quarto project that has the extension installed by typing into the document:
+
+```md
+{{< shortcode-name filename >}}
+```
+
+For example, we can embed RevealJS slides using:
+
+```md
+{{< revealjs "assets/my-slides.html" >}}
+```