dendrite/README.md

# Dendrite [![Build Status](https://badge.buildkite.com/4be40938ab19f2bbc4a6c6724517353ee3ec1422e279faf374.svg?branch=master)](https://buildkite.com/matrix-dot-org/dendrite) [![Dendrite Dev on Matrix](https://img.shields.io/matrix/dendrite-dev:matrix.org.svg?label=%23dendrite-dev%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#dendrite-dev:matrix.org) [![Dendrite on Matrix](https://img.shields.io/matrix/dendrite:matrix.org.svg?label=%23dendrite%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#dendrite:matrix.org)

Dendrite will be a second-generation Matrix homeserver written in Go.

It's still very much a work in progress, but installation instructions can be
found in [INSTALL.md](docs/INSTALL.md). It is not recommended to use Dendrite as a
production homeserver at this time.

An overview of the design can be found in [DESIGN.md](docs/DESIGN.md).

# Contributing

Everyone is welcome to help out and contribute! See
[CONTRIBUTING.md](docs/CONTRIBUTING.md) to get started!

Please note that, as of February 2020, Dendrite now only targets Go 1.13 or
later. Please ensure that you are using at least Go 1.13 when developing for
Dendrite.

# Discussion

For questions about Dendrite we have a dedicated room on Matrix
[#dendrite:matrix.org](https://matrix.to/#/#dendrite:matrix.org). Development
discussion should happen in
[#dendrite-dev:matrix.org](https://matrix.to/#/#dendrite-dev:matrix.org).

# Progress

There's plenty still to do to make Dendrite usable! We're tracking progress in a
[project board](https://github.com/matrix-org/dendrite/projects/2).
Clean up CircleCI leftovers (#801) 2019-10-01 22:01:52 -05:00			# Dendrite [![Build Status](https://badge.buildkite.com/4be40938ab19f2bbc4a6c6724517353ee3ec1422e279faf374.svg?branch=master)](https://buildkite.com/matrix-dot-org/dendrite) [![Dendrite Dev on Matrix](https://img.shields.io/matrix/dendrite-dev:matrix.org.svg?label=%23dendrite-dev%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#dendrite-dev:matrix.org) [![Dendrite on Matrix](https://img.shields.io/matrix/dendrite:matrix.org.svg?label=%23dendrite%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#dendrite:matrix.org)
Add README 2017-01-20 12:25:51 -06:00
Update documentation for Go 1.13 (#867) 2020-02-06 05:54:26 -06:00			`Dendrite will be a second-generation Matrix homeserver written in Go.`
Add README 2017-01-20 12:25:51 -06:00
Update documentation for Go 1.13 (#867) 2020-02-06 05:54:26 -06:00			`It's still very much a work in progress, but installation instructions can be`
Update INSTALL.md, move docs (#1034) * Update INSTALL.md * Move some things * Clean up * Move some more things * Don't build all the things for the monolith * Update INSTALL.md * Nuke hooks 2020-05-14 10:49:18 -05:00			`found in [INSTALL.md](docs/INSTALL.md). It is not recommended to use Dendrite as a`
Update documentation for Go 1.13 (#867) 2020-02-06 05:54:26 -06:00			`production homeserver at this time.`
Add installation instructions to repo (#192) 2017-08-21 11:34:05 -05:00
Update INSTALL.md, move docs (#1034) * Update INSTALL.md * Move some things * Clean up * Move some more things * Don't build all the things for the monolith * Update INSTALL.md * Nuke hooks 2020-05-14 10:49:18 -05:00			`An overview of the design can be found in [DESIGN.md](docs/DESIGN.md).`
Add installation instructions to repo (#192) 2017-08-21 11:34:05 -05:00
Clean up README a bit (#289) 2017-10-10 03:33:41 -05:00			`# Contributing`
Add README 2017-01-20 12:25:51 -06:00
Update documentation for Go 1.13 (#867) 2020-02-06 05:54:26 -06:00			`Everyone is welcome to help out and contribute! See`
Update INSTALL.md, move docs (#1034) * Update INSTALL.md * Move some things * Clean up * Move some more things * Don't build all the things for the monolith * Update INSTALL.md * Nuke hooks 2020-05-14 10:49:18 -05:00			`[CONTRIBUTING.md](docs/CONTRIBUTING.md) to get started!`
Add README 2017-01-20 12:25:51 -06:00
Update documentation for Go 1.13 (#867) 2020-02-06 05:54:26 -06:00			`Please note that, as of February 2020, Dendrite now only targets Go 1.13 or`
			`later. Please ensure that you are using at least Go 1.13 when developing for`
			`Dendrite.`
Add README 2017-01-20 12:25:51 -06:00
Clean up README a bit (#289) 2017-10-10 03:33:41 -05:00			`# Discussion`
Add README 2017-01-20 12:25:51 -06:00
Clean up README a bit (#289) 2017-10-10 03:33:41 -05:00			`For questions about Dendrite we have a dedicated room on Matrix`
Update documentation for Go 1.13 (#867) 2020-02-06 05:54:26 -06:00			`[#dendrite:matrix.org](https://matrix.to/#/#dendrite:matrix.org). Development`
			`discussion should happen in`
Add #dendrite-dev to the README (#699) I suspect this is why we're getting a lot of people coming in to #dendrite asking dev-related questions. 2019-03-27 12:36:45 -05:00			`[#dendrite-dev:matrix.org](https://matrix.to/#/#dendrite-dev:matrix.org).`
Add README 2017-01-20 12:25:51 -06:00
Clean up README a bit (#289) 2017-10-10 03:33:41 -05:00			`# Progress`
Add README 2017-01-20 12:25:51 -06:00
Update documentation for Go 1.13 (#867) 2020-02-06 05:54:26 -06:00			`There's plenty still to do to make Dendrite usable! We're tracking progress in a`
			`[project board](https://github.com/matrix-org/dendrite/projects/2).`
Kick CI 2020-02-28 08:46:03 -06:00