From 192acd1bc2765ce6cfb3e13cd088672ba707e155 Mon Sep 17 00:00:00 2001 From: Alexander Date: Wed, 19 Jul 2023 22:42:48 -0700 Subject: [PATCH] docs --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 170c1d7..0183ef9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ This is a [Discourse] plugin which turns a BBcode-style `[setlist]` tag into a [ ## Usage -A button will be added to the post editor, with the text "Gizzard Setlist". +Entering `[setlist]` (date) `[/setlist]` tag into a post will turn into a click-to-load button which turns into a tooltip showing the specified show's setlist, with a link to the full page for the show. + +A button will be added to the post editor (in the "more"/gear icon menu), with the text "Gizz Setlist". Clicking it will insert a `[setlist]` example tag with the placeholder text "YYYY-MM-DD". (In the preview window, it will initially be red because the letters are an invalid date; once you've entered a valid (numerical) date, it will appear with a green border.) ## Links