diff --git a/README.md b/README.md index bff2cb12..101d8fb3 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,30 @@ -matrix-hookshot +Matrix Hookshot =============== -*Previously matrix-github* - [![#hookshot:half-shot.uk](https://img.shields.io/matrix/hookshot:half-shot.uk.svg?server_fqdn=chaotic.half-shot.uk&label=%23hookshot:half-shot.uk&logo=matrix)](https://matrix.to/#/#hookshot:half-shot.uk) [![Docker Image Version (latest by date)](https://img.shields.io/docker/v/halfshot/matrix-hookshot?sort=semver)](https://hub.docker.com/r/halfshot/matrix-hookshot) -A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA. +![screenshot](screenshot.png) -## Featureset +A Matrix bot for connecting to external services like GitHub, GitLab, JIRA, and more. -This bridge supports: -- Figma - - File comments -- GitHub - - Webhooks (new issues, pull requests, releases etc) - - Commands (create issues, assign issues, start workflows etc) -- GitLab - - Webhooks (new issues, merge requests etc) - - Commands -- Jira - - Webhooks (new issues, issue changes) - - Commands (create new issues) -- Generic webhooks - - Webhooks (via GET, PUT or POST with optional transformation functions) -- RSS/Atom feeds - - New entries +- Several services are supported out of the box. +- [Webhooks](https://matrix-org.github.io/matrix-hookshot/latest/setup/webhooks.html) let you connect all kinds of services, with the ability to write rich templates using JavaScript. +- **No external database** is required, instead using Matrix state as a persistent store. +- End-to-Bridge encryption allows bots to be used in encrypted Matrix rooms. +- [Powerful widgets](https://matrix-org.github.io/matrix-hookshot/latest/advanced/widgets.html) let you configure Hookshot from a room or the Element Extensions Store. -## Setup +We richly support the following integrations: + +- [Figma](https://matrix-org.github.io/matrix-hookshot/latest/setup/figma.html) +- [Generic Webhooks](https://matrix-org.github.io/matrix-hookshot/latest/setup/webhooks.html) +- [GitHub](https://matrix-org.github.io/matrix-hookshot/latest/setup/github.html) +- [GitLab](https://matrix-org.github.io/matrix-hookshot/latest/setup/gitlab.html) +- [Jira](https://matrix-org.github.io/matrix-hookshot/latest/setup/jira.html) +- [RSS/Atom feeds](https://matrix-org.github.io/matrix-hookshot/latest/setup/feeds.html) + +Get started by reading the [the setup guide](https://matrix-org.github.io/matrix-hookshot/latest/setup.html)! -[See the setup guide](https://matrix-org.github.io/matrix-hookshot/latest/setup.html) ## Documentation @@ -44,4 +39,4 @@ sensible-browser book/index.html ## Contact -We have a bridge support room you can drop into at [#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk). +We have a Matrix support room ([#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk)). diff --git a/changelog.d/726.misc b/changelog.d/726.misc new file mode 100644 index 00000000..8bab751f --- /dev/null +++ b/changelog.d/726.misc @@ -0,0 +1 @@ +Update the README with a prettier set of features. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 9f689f09..ffd6b673 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -3,7 +3,7 @@ - [ℹī¸ Hookshot](./hookshot.md) - [⚙ī¸ Setup](./setup.md) - [📃 Sample Configuration](./setup/sample-configuration.md) - - [Feed](./setup/feeds.md) + - [Feeds](./setup/feeds.md) - [Figma](./setup/figma.md) - [GitHub](./setup/github.md) - [GitLab](./setup/gitlab.md) diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 00000000..0d10444d Binary files /dev/null and b/screenshot.png differ