diff --git a/README.md b/README.md index 543794825c46a22264e806654b8fbe09df0413c9..08e9b299d8b7f6254bd50e0d4b6c47d4b8140932 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,27 @@ which lets users share links to matrix entities without being tied to a specific app. Stylistically it serves as a landing page for rooms and communities. +## How can I put a badge on my website linking to my matrix room? + +You can use the badge image we've put up at https://matrix.to/img/matrix-badge.svg, and use it in a link like this: + +[](https://matrix.to/#/#matrix.to:matrix.org) + +You can use this Markdown: +```md +[](https://matrix.to/#/#matrix.to:matrix.org) +``` + +Or this HTML: + +```html +<a href="https://matrix.to/#/#matrix.to:matrix.org" rel="noopener" target="_blank"><img src="https://matrix.to/img/matrix-badge.svg" alt="Chat on Matrix"></a> +``` + +to show the badge. + +## How does matrix.to work? + Matrix.to preserves user privacy by not sharing any information about the links being followed with the Matrix.to server - the redirection is calculated entirely clientside using JavaScript, and the link details is hidden behind a @@ -21,6 +42,8 @@ point at an alternative deployment of the service. The Matrix.to service could also be hosted in an immutable/signed environment such as IPFS to further increase its availability and avoid tampering. +## URL Scheme + The matrix.to URL scheme is | Entity type: | Example URL |