nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 21:19:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
hookshot/README.md

44 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

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>
2023-04-24 15:48:00 +01:00
Matrix Hookshot
Fix opening line
2021-11-22 17:06:48 +00:00
===============
README
2019-08-02 19:15:33 +01:00
Fix readme badges
2022-01-14 19:22:37 +00:00
[![#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)
Vastly improve README
2019-08-07 18:56:50 +01: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>
2023-04-24 15:48:00 +01:00
![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.
Vastly improve README
2019-08-07 18:56:50 +01: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>
2023-04-24 15:48:00 +01:00
We richly support the following integrations:
Add documentation on various things (#90) * Add details on webhooks * More doc things * More docs * More documentation changes * Tidy tidy * Lots more documentation * Support defaults for all GitHub configuration options * Add metrics changes * s/Added/Add
2021-12-21 16:41:19 +00:00
Add challengeHound to README (#932) Signed-off-by: Will Hunt <will@half-shot.uk>
2024-04-19 08:42:40 +01:00
- [Challenge Hound](https://matrix-org.github.io/matrix-hookshot/latest/setup/challengehound.html)
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>
2023-04-24 15:48:00 +01:00
- [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)
Vastly improve README
2019-08-07 18:56:50 +01:00
Update README.md (#855) * Update README.md Smaller improvements. Fixed a typo. * Create 855.doc --------- Co-authored-by: Will Hunt <will@half-shot.uk>
2023-12-20 11:33:33 +01:00
Get started by reading [the setup guide](https://matrix-org.github.io/matrix-hookshot/latest/setup.html)!
Vastly improve README
2019-08-07 18:56:50 +01:00
Add note on how to build docs
2021-12-01 18:01:19 +00:00
## Documentation
Fix readme links
2022-03-02 18:16:04 +00:00
Documentation can be found on [GitHub Pages](https://matrix-org.github.io/matrix-hookshot).
Add note on how to build docs
2021-12-01 18:01:19 +00:00
Update README.md (#855) * Update README.md Smaller improvements. Fixed a typo. * Create 855.doc --------- Co-authored-by: Will Hunt <will@half-shot.uk>
2023-12-20 11:33:33 +01:00
You can build the documentation yourself by typing:
Add note on how to build docs
2021-12-01 18:01:19 +00:00
```sh
# cargo install mdbook
mdbook build
sensible-browser book/index.html
```
Vastly improve README
2019-08-07 18:56:50 +01:00
## Contact
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>
2023-04-24 15:48:00 +01:00
We have a Matrix support room ([#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk)).
Reference in New Issue Copy Permalink