Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Imporve the README for first time readers #726

Merged
merged 6 commits into from
Apr 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 19 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

A Matrix bot for connecting to external services like GitHub, GitLab, JIRA, and more.

- 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.

## Featureset
We richly support the following integrations:

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
- [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)

## Setup
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

Expand All @@ -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)).
1 change: 1 addition & 0 deletions changelog.d/726.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update the README with a prettier set of features.
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.