Skip to content

Commit

Permalink
chore: update documentation in README.md and add vscode settings
Browse files Browse the repository at this point in the history
  • Loading branch information
xeekworx committed Jan 13, 2024
1 parent 19d0737 commit af9de18
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"cSpell.words": [
"connectorcard",
"pymsteams"
]
}
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 (;).
Expand Down

0 comments on commit af9de18

Please sign in to comment.