Skip to content

Commit ba5b28a

Browse files
Half-Shotjustinbot
andauthored
Imporve the README for first time readers (#726)
* New README * Plural feeds * Add a nice screeny * Apply wordsmithing Co-authored-by: Justin Carlson <[email protected]> * Actually reference the screenshot * Better screenshot --------- Co-authored-by: Justin Carlson <[email protected]>
1 parent 4bb4b56 commit ba5b28a

File tree

4 files changed

+21
-25
lines changed

4 files changed

+21
-25
lines changed

README.md

+19-24
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,30 @@
1-
matrix-hookshot
1+
Matrix Hookshot
22
===============
33

4-
*Previously matrix-github*
5-
64
[![#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)
75
[![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)
86

9-
A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA.
7+
![screenshot](screenshot.png)
8+
9+
A Matrix bot for connecting to external services like GitHub, GitLab, JIRA, and more.
10+
11+
- Several services are supported out of the box.
12+
- [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.
13+
- **No external database** is required, instead using Matrix state as a persistent store.
14+
- End-to-Bridge encryption allows bots to be used in encrypted Matrix rooms.
15+
- [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.
1016

11-
## Featureset
17+
We richly support the following integrations:
1218

13-
This bridge supports:
14-
- Figma
15-
- File comments
16-
- GitHub
17-
- Webhooks (new issues, pull requests, releases etc)
18-
- Commands (create issues, assign issues, start workflows etc)
19-
- GitLab
20-
- Webhooks (new issues, merge requests etc)
21-
- Commands
22-
- Jira
23-
- Webhooks (new issues, issue changes)
24-
- Commands (create new issues)
25-
- Generic webhooks
26-
- Webhooks (via GET, PUT or POST with optional transformation functions)
27-
- RSS/Atom feeds
28-
- New entries
19+
- [Figma](https://matrix-org.github.io/matrix-hookshot/latest/setup/figma.html)
20+
- [Generic Webhooks](https://matrix-org.github.io/matrix-hookshot/latest/setup/webhooks.html)
21+
- [GitHub](https://matrix-org.github.io/matrix-hookshot/latest/setup/github.html)
22+
- [GitLab](https://matrix-org.github.io/matrix-hookshot/latest/setup/gitlab.html)
23+
- [Jira](https://matrix-org.github.io/matrix-hookshot/latest/setup/jira.html)
24+
- [RSS/Atom feeds](https://matrix-org.github.io/matrix-hookshot/latest/setup/feeds.html)
2925

30-
## Setup
26+
Get started by reading the [the setup guide](https://matrix-org.github.io/matrix-hookshot/latest/setup.html)!
3127

32-
[See the setup guide](https://matrix-org.github.io/matrix-hookshot/latest/setup.html)
3328

3429
## Documentation
3530

@@ -44,4 +39,4 @@ sensible-browser book/index.html
4439

4540
## Contact
4641

47-
We have a bridge support room you can drop into at [#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk).
42+
We have a Matrix support room ([#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk)).

changelog.d/726.misc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update the README with a prettier set of features.

docs/SUMMARY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- [ℹ️ Hookshot](./hookshot.md)
44
- [⚙️ Setup](./setup.md)
55
- [📃 Sample Configuration](./setup/sample-configuration.md)
6-
- [Feed](./setup/feeds.md)
6+
- [Feeds](./setup/feeds.md)
77
- [Figma](./setup/figma.md)
88
- [GitHub](./setup/github.md)
99
- [GitLab](./setup/gitlab.md)

screenshot.png

358 KB
Loading

0 commit comments

Comments
 (0)