From af9de18ff788e11cd1051a18698f6dd4985db9bb Mon Sep 17 00:00:00 2001
From: Xeek <xeek@xeekworx.com>
Date: Sat, 13 Jan 2024 12:29:53 -0600
Subject: [PATCH] chore: update documentation in README.md and add vscode
 settings

---
 .vscode/settings.json | 6 ++++++
 README.md             | 9 +++++++--
 2 files changed, 13 insertions(+), 2 deletions(-)
 create mode 100644 .vscode/settings.json

diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 0000000..02d2bde
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+    "cSpell.words": [
+        "connectorcard",
+        "pymsteams"
+    ]
+}
\ No newline at end of file
diff --git a/README.md b/README.md
index 8f5b783..21b0636 100644
--- a/README.md
+++ b/README.md
@@ -10,12 +10,17 @@ Sends a custom connector card to a Microsoft Teams channel using a webhook URL.
 
 - `webhook-url` (required):
   - Description: Webhook URL of the Microsoft Teams channel.
+  - Documentation: [Create Incoming Webhooks](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format?tabs=adaptive-md%2Cdesktop%2Cconnector-html#format-cards-with-markdown])
 - `message-title` (required):
   - Description: The title of the teams connector card.
 - `message-body` (required):
-  - Description: The body of the message to send.
+  - Description: The body of the message to send. Markdown is allowed.
+  - Documentation: [Format cards in Microsoft Teams](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format?tabs=adaptive-md%2Cdesktop%2Cconnector-html#format-cards-with-markdown)
 - `card-color` (optional):
-  - Description: The color of the card (hex) or named colors including GREEN, YELLOW, or RED.
+  - Description: The color of the card (hex, eg. #22c74e) or predefined colors including:
+    - ![#22c74e](https://placehold.co/20/22c74e/22c74e) GREEN
+    - ![#c73022](https://placehold.co/20/c73022/c73022) YELLOW
+    - ![#c7bf22](https://placehold.co/20/c7bf22/c7bf22) RED
   - Default: Not specified.
 - `buttons` (optional):
   - Description: Buttons to add to the card. Each button is a pair of text and link separated by a new line or semicolon (;).