From 661a94367221c46f62b7235fc22c90c3f11baf1e Mon Sep 17 00:00:00 2001 From: projectmoon Date: Mon, 6 Sep 2021 22:15:20 +0000 Subject: [PATCH] Readme Updates (#91) Add contributing information. Add support/community section. Add matrix room badge Co-Authored-By: projectmoon Co-Committed-By: projectmoon --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index d51ac4d..7fe3ccb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Tenebrous Dicebot [![Build Status](https://drone.agnos.is/api/badges/projectmoon/tenebrous-dicebot/status.svg)](https://drone.agnos.is/projectmoon/tenebrous-dicebot) +[![Matrix Chat](https://img.shields.io/matrix/tenebrous:agnos.is?label=matrix&server_fqdn=matrix.org)][matrix-room] _This repository is hosted on [Agnos.is Git][main-repo] and mirrored to [GitHub][github-repo]._ @@ -24,6 +25,23 @@ System. * Works in encrypted or unencrypted Matrix rooms. * Storing variables created by the user. +## Support and Community + +The project has a Matrix room at [#tenebrous:agnos.is][matrix-room]. +It is also possible to make a post in [GitHub +Discussions][github-discussions]. + +For reporting bugs, we prefer that you open an issue on +[git.agnos.is][agnosis-git-issues]. However, you may also open an +issue on [GitHub][github-issues]. + +### Development and Contributions + +All development occurs on [git.agnos.is][main-repo]. If you wish to +contribute, please open a pull request there. In some cases, pull +requests from GitHub may be accepted. All contributions must be +licensed under [AGPL 3.0 or later][agpl] to be accepted. + ## Building and Installation ### Docker Image @@ -266,3 +284,8 @@ support added for Chronicles of Darkness and Call of Cthulhu. [github-repo]: https://github.com/ProjectMoon/matrix-dicebot [roadmap]: https://git.agnos.is/projectmoon/tenebrous-dicebot/wiki/Roadmap [crates-io]: https://crates.io/crates/tenebrous-dicebot +[matrix-room]: https://matrix.to/#/#tenebrous:agnos.is +[agnosis-git-issues]: https://git.agnos.is/projectmoon/tenebrous-dicebot/issues +[github-discussions]: https://github.com/ProjectMoon/matrix-dicebot/discussions +[github-issues]: https://github.com/ProjectMoon/matrix-dicebot/issues +[agpl]: https://www.gnu.org/licenses/agpl-3.0.en.html