From 15d69853042bd7a03e93527111821e45acfea114 Mon Sep 17 00:00:00 2001
From: "pinkforest(she/her)" <36498018+pinkforest@users.noreply.github.com>
Date: Mon, 15 Aug 2022 03:55:18 +1000
Subject: [PATCH] Document `references` field (#1354)

* Add references to README.md example

* TOML syntax

* Comment out optional field

Signed-off-by: pinkforest <36498018+pinkforest@users.noreply.github.com>

Signed-off-by: pinkforest <36498018+pinkforest@users.noreply.github.com>
---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index 56acf7ea5..2ea983b22 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,9 @@ date = "2021-01-31"
 # a change log entry, or a blogpost announcing the release (optional)
 url = "https://github.com/mystuff/mycrate/issues/123"
 
+# URL to additional helpful references regarding the advisory (optional)
+#references = ["https://github.com/mystuff/mycrate/discussions/1"]
+
 # Optional: Indicates the type of informational advisory
 #  - "unsound" for soundness issues
 #  - "unmaintained" for crates that are no longer maintained