Further document new features

This commit is contained in:
Max Dor
2019-04-09 12:06:13 +02:00
parent a7b5accd75
commit 6cc17abf2c
3 changed files with 26 additions and 7 deletions

View File

@@ -6,6 +6,9 @@
- [Apache](#apache)
- [Homeserver](#homeserver)
- [synapse](#synapse)
- [Configuration](#configuration)
- [Example](#example)
- [Usage](#usage)
## Overview
**NOTE**: This feature is beta: it is considered stable enough for production but is incomplete and may contain bugs.
@@ -22,7 +25,7 @@ can register on a given server in a implementation-agnostic manner.
the registration process.
As such, it relies on the homeserver to require 3PIDs with the registration flows.
This feature is not part of the Matrix spec.
This feature is not part of the Matrix Identity Server spec.
## Integration
mxisd needs to be integrated at several levels for this feature to work:
@@ -87,7 +90,7 @@ The following table illustrates pattern and maching status against example value
| `.example.org` | No | Yes |
| `example.org` | Yes | No |
### Full example
### Example
For the following example configuration:
```yaml
register: