Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
+ Add badges
+ Strip contrib-related docs for Docker Hub
+ Move links
+ Add copyright and license
  • Loading branch information
bgandon committed Feb 6, 2024
1 parent d33937c commit 198d282
Showing 1 changed file with 35 additions and 8 deletions.
43 changes: 35 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
[![Docker Stars](https://img.shields.io/docker/stars/cfcommunity/slack-notification-resource.svg?style=plastic)](https://registry.hub.docker.com/v2/repositories/cfcommunity/slack-notification-resource/stars/count/)
[![Docker pulls](https://img.shields.io/docker/pulls/cfcommunity/slack-notification-resource.svg?style=plastic)](https://registry.hub.docker.com/v2/repositories/cfcommunity/slack-notification-resource)
<!--
[![Concourse Build](https://ci.gstack.io/api/v1/teams/gk-plat-devs/pipelines/slack-notification-resource/jobs/build/badge)](https://ci.gstack.io/teams/gk-plat-devs/pipelines/slack-notification-resource)
-->
[![dockeri.co](https://dockeri.co/image/cfcommunity/slack-notification-resource)](https://hub.docker.com/r/cfcommunity/slack-notification-resource/)

Slack notification sending resource
===================================

Expand Down Expand Up @@ -192,6 +199,12 @@ Optional:

Explore formatting with Slack's [Message Builder][build].

[attach]: https://api.slack.com/docs/message-attachment
[uidmap]: https://api.slack.com/changelog/2017-09-the-one-about-usernames#mapping
[chans]: https://api.slack.com/docs/message-formatting#linking_to_channels_and_users
[cl2017]: https://api.slack.com/changelog/2017-09-the-one-about-usernames
[build]: https://api.slack.com/docs/formatting/builder


#### Metadata

Expand Down Expand Up @@ -224,6 +237,8 @@ jobs:
See the [official documentation][meta] for a complete list of
available metadata.

[meta]: https://concourse-ci.org/implementing-resource-types.html#resource-metadata

Examples
--------

Expand Down Expand Up @@ -296,9 +311,12 @@ body: {
"icon_emoji": null,
"channel": null
}

```
<!-- START_OF_DOCKERHUB_STRIP -->
## Release Engineering
To build local versions of this, for testing:
Expand All @@ -314,13 +332,22 @@ To cut a new officialy release of the
$ make VERSION=x.y.z release
[hub]: https://hub.docker.com/r/cfcommunity/slack-notification-resource
<!-- END_OF_DOCKERHUB_STRIP -->
[hub]: https://hub.docker.com/r/cfcommunity/slack-notification-resource
[attach]: https://api.slack.com/docs/message-attachment
[uidmap]: https://api.slack.com/changelog/2017-09-the-one-about-usernames#mapping
[chans]: https://api.slack.com/docs/message-formatting#linking_to_channels_and_users
[cl2017]: https://api.slack.com/changelog/2017-09-the-one-about-usernames
[build]: https://api.slack.com/docs/formatting/builder
[meta]: https://concourse-ci.org/implementing-resource-types.html#resource-metadata
## Author and license
Copyright © 2017-2020, James Hunt
Copyright © 2021-present, Benjamin Gandon, Gstack
The Slack notification resource is released under the terms of the
[MIT license](./LICENSE).
<!--
# Local Variables:
# indent-tabs-mode: nil
# End:
-->

0 comments on commit 198d282

Please sign in to comment.