stryan/matrix.to
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Bruno Windels 2021-06-11 08:15:17 +00:00 committed by GitHub
parent bfffe55fcc
commit 3738594fbc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -5,6 +5,27 @@ which lets users share links to matrix entities without being tied to a
specific app. specific app.
Stylistically it serves as a landing page for rooms and communities. 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:
[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#matrix.to:matrix.org)
You can use this Markdown:
```md
[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](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 Matrix.to preserves user privacy by not sharing any information about the links
being followed with the Matrix.to server - the redirection is calculated being followed with the Matrix.to server - the redirection is calculated
entirely clientside using JavaScript, and the link details is hidden behind a 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 also be hosted in an immutable/signed environment such as IPFS to further
increase its availability and avoid tampering. increase its availability and avoid tampering.
## URL Scheme
The matrix.to URL scheme is The matrix.to URL scheme is
| Entity type: | Example URL | | Entity type: | Example URL |