From 73bf432bfaafdd3f3fd7ad84e0ae987427796b01 Mon Sep 17 00:00:00 2001
From: Ferran Jovell <ferran.jovell@hybridtheory.com>
Date: Mon, 23 Aug 2021 11:56:21 +0200
Subject: [PATCH] Adds more information about embedded YAML in the README.

After the discussion in https://github.com/simonw/markdown-to-sqlite/issues/5
I figured it could be useful for other people to have that information
directly into the readme.
---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index 2e60dbd..9ecf7f0 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,9 @@
 CLI tool for loading markdown files into a SQLite database.
 
 YAML embedded in the markdown files will be used to populate additional columns.
+See the [pandoc documentation](https://pandoc.org/MANUAL.html#metadata-variables)
+for more information. Only caveat is that the embedded YAML has to be
+terminated with `---` instead.
 
     Usage: markdown-to-sqlite [OPTIONS] DBNAME TABLE PATHS...