forked from dasrick/go-teams-notify
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
REAMDE | Update syntax, fix misc linting issues
- Replace `dasrick` with `atc0005` where applicable - Remove CI badges specific to services that dasrick used for the parent project - Fix misc linting issues regarding whitespace, headers and so forth
- Loading branch information
Showing
1 changed file
with
38 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,93 +1,73 @@ | ||
[![Build Status][travis-image]][travis-url] | ||
[![Github Tag][githubtag-image]][githubtag-url] | ||
<!-- omit in toc --> | ||
# go-teams-notify | ||
|
||
[![Coverage Status][coveralls-image]][coveralls-url] | ||
[![Maintainability][codeclimate-image]][codeclimate-url] | ||
[![codecov][codecov-image]][codecov-url] | ||
A package to send messages to Microsoft Teams (channels) | ||
|
||
[![Go Report Card][goreport-image]][goreport-url] | ||
[![Github Tag][githubtag-image]][githubtag-url] | ||
[![GoDoc][godoc-image]][godoc-url] | ||
[![License][license-image]][license-url] | ||
|
||
*** | ||
|
||
# go-teams-notify | ||
|
||
> A package to send messages to Microsoft Teams (channels) | ||
<!-- omit in toc --> | ||
## Table of contents | ||
|
||
... | ||
- [Usage](#usage) | ||
- [References](#references) | ||
|
||
# Usage | ||
## Usage | ||
|
||
To get the package, execute: | ||
|
||
``` | ||
go get https://github.com/dasrick/go-teams-notify/v2 | ||
```console | ||
go get https://github.com/atc0005/go-teams-notify/v2 | ||
``` | ||
|
||
To import this package, add the following line to your code: | ||
|
||
``` | ||
import "github.com/dasrick/go-teams-notify/v2" | ||
```golang | ||
import "github.com/atc0005/go-teams-notify/v2" | ||
``` | ||
|
||
And this is an example of a simple implementation ... | ||
|
||
``` | ||
```golang | ||
import ( | ||
"github.com/dasrick/go-teams-notify/v2" | ||
"github.com/atc0005/go-teams-notify/v2" | ||
) | ||
|
||
func main() { | ||
_ = sendTheMessage() | ||
_ = sendTheMessage() | ||
} | ||
|
||
func sendTheMessage() error { | ||
// init the client | ||
mstClient := goteamsnotify.NewClient() | ||
// init the client | ||
mstClient := goteamsnotify.NewClient() | ||
|
||
// setup webhook url | ||
webhookUrl := "https://outlook.office.com/webhook/YOUR_WEBHOOK_URL_OF_TEAMS_CHANNEL" | ||
// setup webhook url | ||
webhookUrl := "https://outlook.office.com/webhook/YOUR_WEBHOOK_URL_OF_TEAMS_CHANNEL" | ||
|
||
// setup message card | ||
msgCard := goteamsnotify.NewMessageCard() | ||
msgCard.Title = "Hello world" | ||
msgCard.Text = "Here are some examples of formatted stuff like <br> * this list itself <br> * **bold** <br> * *italic* <br> * ***bolditalic***" | ||
msgCard.ThemeColor = "#DF813D" | ||
// setup message card | ||
msgCard := goteamsnotify.NewMessageCard() | ||
msgCard.Title = "Hello world" | ||
msgCard.Text = "Here are some examples of formatted stuff like "+ | ||
"<br> * this list itself <br> * **bold** <br> * *italic* <br> * ***bolditalic***" | ||
msgCard.ThemeColor = "#DF813D" | ||
|
||
// send | ||
return mstClient.Send(webhookUrl, msgCard) | ||
// send | ||
return mstClient.Send(webhookUrl, msgCard) | ||
} | ||
``` | ||
|
||
# <a id="links"></a>some useful links | ||
|
||
* [MS Teams - adaptive cards](https://docs.microsoft.com/de-de/outlook/actionable-messages/adaptive-card) | ||
* [MS Teams - send via connectors](https://docs.microsoft.com/de-de/outlook/actionable-messages/send-via-connectors) | ||
* [adaptivecards.io](https://adaptivecards.io/designer) | ||
|
||
*** | ||
|
||
[travis-image]: https://travis-ci.org/dasrick/go-teams-notify.svg?branch=master | ||
[travis-url]: https://travis-ci.org/dasrick/go-teams-notify | ||
|
||
[githubtag-image]: https://img.shields.io/github/tag/dasrick/go-teams-notify.svg?style=flat | ||
[githubtag-url]: https://github.com/dasrick/go-teams-notify | ||
|
||
[coveralls-image]: https://coveralls.io/repos/github/dasrick/go-teams-notify/badge.svg?branch=master | ||
[coveralls-url]: https://coveralls.io/github/dasrick/go-teams-notify?branch=master | ||
|
||
[codeclimate-image]: https://api.codeclimate.com/v1/badges/fe69cc992370b3f97d94/maintainability | ||
[codeclimate-url]: https://codeclimate.com/github/dasrick/go-teams-notify/maintainability | ||
## References | ||
|
||
[codecov-image]: https://codecov.io/gh/dasrick/go-teams-notify/branch/master/graph/badge.svg | ||
[codecov-url]: https://codecov.io/gh/dasrick/go-teams-notify | ||
- [MS Teams - adaptive cards](https://docs.microsoft.com/de-de/outlook/actionable-messages/adaptive-card) | ||
- [MS Teams - send via connectors](https://docs.microsoft.com/de-de/outlook/actionable-messages/send-via-connectors) | ||
- [adaptivecards.io](https://adaptivecards.io/designer) | ||
|
||
[goreport-image]: https://goreportcard.com/badge/github.com/dasrick/go-teams-notify | ||
[goreport-url]: https://goreportcard.com/report/github.com/dasrick/go-teams-notify | ||
[githubtag-image]: https://img.shields.io/github/tag/atc0005/go-teams-notify.svg?style=flat | ||
[githubtag-url]: https://github.com/atc0005/go-teams-notify | ||
|
||
[godoc-image]: https://godoc.org/github.com/dasrick/go-teams-notify?status.svg | ||
[godoc-url]: https://godoc.org/github.com/dasrick/go-teams-notify | ||
[godoc-image]: https://godoc.org/github.com/atc0005/go-teams-notify?status.svg | ||
[godoc-url]: https://godoc.org/github.com/atc0005/go-teams-notify | ||
|
||
[license-image]: https://img.shields.io/github/license/dasrick/go-teams-notify.svg?style=flat | ||
[license-url]: https://github.com/dasrick/go-teams-notify/blob/master/LICENSE | ||
[license-image]: https://img.shields.io/github/license/atc0005/go-teams-notify.svg?style=flat | ||
[license-url]: https://github.com/atc0005/go-teams-notify/blob/master/LICENSE |