Skip to content

Commit

Permalink
Document references field (#1354)
Browse files Browse the repository at this point in the history 
* 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>
  • Loading branch information
@pinkforest
pinkforest committed Aug 14, 2022
1 parent d86ec54 commit 15d6985
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 15d6985

Please sign in to comment.