mirror of
https://github.com/matrix-org/matrix-hookshot.git
synced 2025-03-10 13:17:08 +00:00
Imporve the README for first time readers (#726)
* New README * Plural feeds * Add a nice screeny * Apply wordsmithing Co-authored-by: Justin Carlson <justinc@element.io> * Actually reference the screenshot * Better screenshot --------- Co-authored-by: Justin Carlson <justinc@element.io>
This commit is contained in:
parent
4bb4b56875
commit
ba5b28ab92
43
README.md
43
README.md
@ -1,35 +1,30 @@
|
|||||||
matrix-hookshot
|
Matrix Hookshot
|
||||||
===============
|
===============
|
||||||
|
|
||||||
*Previously matrix-github*
|
|
||||||
|
|
||||||
[](https://matrix.to/#/#hookshot:half-shot.uk)
|
[](https://matrix.to/#/#hookshot:half-shot.uk)
|
||||||
[](https://hub.docker.com/r/halfshot/matrix-hookshot)
|
[](https://hub.docker.com/r/halfshot/matrix-hookshot)
|
||||||
|
|
||||||
A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA.
|

|
||||||
|
|
||||||
## Featureset
|
A Matrix bot for connecting to external services like GitHub, GitLab, JIRA, and more.
|
||||||
|
|
||||||
This bridge supports:
|
- Several services are supported out of the box.
|
||||||
- Figma
|
- [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.
|
||||||
- File comments
|
- **No external database** is required, instead using Matrix state as a persistent store.
|
||||||
- GitHub
|
- End-to-Bridge encryption allows bots to be used in encrypted Matrix rooms.
|
||||||
- Webhooks (new issues, pull requests, releases etc)
|
- [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.
|
||||||
- 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
|
|
||||||
|
|
||||||
## 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
|
## Documentation
|
||||||
|
|
||||||
@ -44,4 +39,4 @@ sensible-browser book/index.html
|
|||||||
|
|
||||||
## Contact
|
## 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
changelog.d/726.misc
Normal file
1
changelog.d/726.misc
Normal file
@ -0,0 +1 @@
|
|||||||
|
Update the README with a prettier set of features.
|
@ -3,7 +3,7 @@
|
|||||||
- [ℹ️ Hookshot](./hookshot.md)
|
- [ℹ️ Hookshot](./hookshot.md)
|
||||||
- [⚙️ Setup](./setup.md)
|
- [⚙️ Setup](./setup.md)
|
||||||
- [📃 Sample Configuration](./setup/sample-configuration.md)
|
- [📃 Sample Configuration](./setup/sample-configuration.md)
|
||||||
- [Feed](./setup/feeds.md)
|
- [Feeds](./setup/feeds.md)
|
||||||
- [Figma](./setup/figma.md)
|
- [Figma](./setup/figma.md)
|
||||||
- [GitHub](./setup/github.md)
|
- [GitHub](./setup/github.md)
|
||||||
- [GitLab](./setup/gitlab.md)
|
- [GitLab](./setup/gitlab.md)
|
||||||
|
BIN
screenshot.png
Normal file
BIN
screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 358 KiB |
Loading…
x
Reference in New Issue
Block a user