aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNeil Alexander <neilalexander@users.noreply.github.com>2020-02-06 11:54:26 +0000
committerGitHub <noreply@github.com>2020-02-06 11:54:26 +0000
commitb72d7eb0cfdb6cead864c6e7cc0ccec77efa5805 (patch)
treef7906c4279d3fabc27c2d2d70f3b28c6281b14bc /README.md
parentc20109a57357fbb2cd0857485e2cca4a58c37d1b (diff)
Update documentation for Go 1.13 (#867)
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 14 insertions, 11 deletions
diff --git a/README.md b/README.md
index 2dadb1f4..801d0e3c 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,30 @@
# 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 matrix homeserver written in go.
+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](INSTALL.md)
+It's still very much a work in progress, but installation instructions can be
+found in [INSTALL.md](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](DESIGN.md)
+An overview of the design can be found in [DESIGN.md](DESIGN.md).
# Contributing
-Everyone is welcome to help out and contribute! See [CONTRIBUTING.md](CONTRIBUTING.md)
-to get started!
+Everyone is welcome to help out and contribute! See
+[CONTRIBUTING.md](CONTRIBUTING.md) to get started!
-We aim to try and make it as easy as possible to jump in.
+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: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).
+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).