Skip to content

Commit 2657df8

Browse files
committed
Change Riot to Element
1 parent 9687575 commit 2657df8

1 file changed

Lines changed: 32 additions & 32 deletions

File tree

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
Riot
2-
====
1+
Element
2+
=======
33

4-
Riot (formerly known as Vector) is a Matrix web client built using the [Matrix
4+
Riot (formerly known as Vector and Riot) is a Matrix web client built using the [Matrix
55
React SDK](https://github.com/matrix-org/matrix-react-sdk).
66

77
Supported Environments
88
======================
99

10-
Riot has several tiers of support for different environments:
10+
Element has several tiers of support for different environments:
1111

1212
* Supported
1313
* Definition: Issues **actively triaged**, regressions **block** the release
1414
* Last 2 major versions of Chrome, Firefox, and Safari on desktop OSes
15-
* Latest release of official Riot Desktop app on desktop OSes
15+
* Latest release of official Element Desktop app on desktop OSes
1616
* Desktop OSes means macOS, Windows, and Linux versions for desktop devices
1717
that are actively supported by the OS vendor and receive security updates
1818
* Experimental
1919
* Definition: Issues **accepted**, regressions **do not block** the release
20-
* Riot as an installed PWA via current stable version of Chrome, Firefox, and Safari
20+
* Element as an installed PWA via current stable version of Chrome, Firefox, and Safari
2121
* Mobile web for current stable version of Chrome, Firefox, and Safari on Android, iOS, and iPadOS
2222
* Not supported
2323
* Definition: Issues only affecting unsupported environments are **closed**
2424
* Everything else
2525

26-
For accessing Riot on an Android or iOS device, we currently recommend the
26+
For accessing Element on an Android or iOS device, we currently recommend the
2727
native apps [riot-android](https://github.com/vector-im/riot-android)
2828
and [riot-ios](https://github.com/vector-im/riot-ios).
2929

3030
Getting Started
3131
===============
3232

33-
The easiest way to test Riot is to just use the hosted copy at https://riot.im/app.
34-
The `develop` branch is continuously deployed by Jenkins at https://riot.im/develop
33+
The easiest way to test Element is to just use the hosted copy at https://app.element.io.
34+
The `develop` branch is continuously deployed by Jenkins at https://develop.element.io
3535
for those who like living dangerously.
3636

37-
To host your own copy of Riot, the quickest bet is to use a pre-built
37+
To host your own copy of Element, the quickest bet is to use a pre-built
3838
released version of Riot:
3939

4040
1. Download the latest version from https://github.com/vector-im/riot-web/releases
@@ -43,29 +43,29 @@ released version of Riot:
4343
1. Configure the correct caching headers in your webserver (see below)
4444
1. If desired, copy `config.sample.json` to `config.json` and edit it
4545
as desired. See the [configuration docs](docs/config.md) for details.
46-
1. Enter the URL into your browser and log into Riot!
46+
1. Enter the URL into your browser and log into Element!
4747

4848
Releases are signed using gpg and the OpenPGP standard, and can be checked against the public key located
4949
at https://packages.riot.im/riot-release-key.asc.
5050

51-
Note that for the security of your chats will need to serve Riot
51+
Note that for the security of your chats will need to serve Element
5252
over HTTPS. Major browsers also do not allow you to use VoIP/video
5353
chats over HTTP, as WebRTC is only usable over HTTPS.
5454
There are some exceptions like when using localhost, which is
5555
considered a [secure context](https://developer.mozilla.org/docs/Web/Security/Secure_Contexts)
5656
and thus allowed.
5757

58-
To install Riot as a desktop application, see [Running as a desktop
58+
To install Element as a desktop application, see [Running as a desktop
5959
app](#running-as-a-desktop-app) below.
6060

6161
Important Security Note
6262
=======================
6363

64-
We do not recommend running Riot from the same domain name as your Matrix
64+
We do not recommend running Element from the same domain name as your Matrix
6565
homeserver. The reason is the risk of XSS (cross-site-scripting)
66-
vulnerabilities that could occur if someone caused Riot to load and render
66+
vulnerabilities that could occur if someone caused Element to load and render
6767
malicious user generated content from a Matrix API which then had trusted
68-
access to Riot (or other apps) due to sharing the same domain.
68+
access to Element (or other apps) due to sharing the same domain.
6969

7070
We have put some coarse mitigations into place to try to protect against this
7171
situation, but it's still not good practice to do it in the first place. See
@@ -74,7 +74,7 @@ https://github.com/vector-im/riot-web/issues/1977 for more details.
7474
Building From Source
7575
====================
7676

77-
Riot is a modular webapp built with modern ES6 and uses a Node.js build system.
77+
Element is a modular webapp built with modern ES6 and uses a Node.js build system.
7878
Ensure you have the latest LTS version of Node.js installed.
7979

8080
Using `yarn` instead of `npm` is recommended. Please see the Yarn [install
@@ -88,7 +88,7 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread
8888
* If you're using the `develop` branch, then it is recommended to set up a
8989
proper development environment (see [Setting up a dev
9090
environment](#setting-up-a-dev-environment) below). Alternatively, you
91-
can use https://riot.im/develop - the continuous integration release of
91+
can use https://develop.element.io - the continuous integration release of
9292
the develop branch.
9393
1. Configure the app by copying `config.sample.json` to `config.json` and
9494
modifying it. See the [configuration docs](docs/config.md) for details.
@@ -97,14 +97,14 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread
9797
web server.
9898

9999
Note that `yarn dist` is not supported on Windows, so Windows users can run `yarn build`,
100-
which will build all the necessary files into the `webapp` directory. The version of Riot
100+
which will build all the necessary files into the `webapp` directory. The version of Element
101101
will not appear in Settings without using the dist script. You can then mount the
102102
`webapp` directory on your webserver to actually serve up the app, which is entirely static content.
103103

104104
Running as a Desktop app
105105
========================
106106

107-
Riot can also be run as a desktop app, wrapped in Electron. You can download a
107+
Element can also be run as a desktop app, wrapped in Electron. You can download a
108108
pre-built version from https://riot.im/download/desktop/ or, if you prefer,
109109
build it yourself.
110110

@@ -117,7 +117,7 @@ Other options for running as a desktop app:
117117

118118
```bash
119119
yarn global add nativefier
120-
nativefier https://riot.im/app/
120+
nativefier https://app.element.io/
121121
```
122122

123123
The [configuration docs](docs/config.md#desktop-app-configuration) show how to
@@ -162,19 +162,19 @@ docker build -t vectorim/riot-web:develop \
162162
config.json
163163
===========
164164

165-
Riot supports a variety of settings to configure default servers, behaviour, themes, etc.
165+
Element supports a variety of settings to configure default servers, behaviour, themes, etc.
166166
See the [configuration docs](docs/config.md) for more details.
167167

168168
Labs Features
169169
=============
170170

171-
Some features of Riot may be enabled by flags in the `Labs` section of the settings.
171+
Some features of Element may be enabled by flags in the `Labs` section of the settings.
172172
Some of these features are described in [labs.md](https://github.com/vector-im/riot-web/blob/develop/docs/labs.md).
173173

174174
Caching requirements
175175
====================
176176

177-
Riot requires the following URLs not to be cached, when/if you are serving Riot from your own webserver:
177+
Element requires the following URLs not to be cached, when/if you are serving Element from your own webserver:
178178
```
179179
/config.*.json
180180
/i18n
@@ -188,7 +188,7 @@ Development
188188

189189
Before attempting to develop on Riot you **must** read the [developer guide
190190
for `matrix-react-sdk`](https://github.com/matrix-org/matrix-react-sdk#developer-guide), which
191-
also defines the design, architecture and style for Riot too.
191+
also defines the design, architecture and style for Element too.
192192

193193
Before starting work on a feature, it's best to ensure your plan aligns well
194194
with our vision for Riot. Please chat with the team in
@@ -199,23 +199,23 @@ You should also familiarise yourself with the ["Here be Dragons" guide
199199
](https://docs.google.com/document/d/12jYzvkidrp1h7liEuLIe6BMdU0NUjndUYI971O06ooM)
200200
to the tame & not-so-tame dragons (gotchas) which exist in the codebase.
201201

202-
The idea of Riot is to be a relatively lightweight "skin" of customisations on
202+
The idea of Element is to be a relatively lightweight "skin" of customisations on
203203
top of the underlying `matrix-react-sdk`. `matrix-react-sdk` provides both the
204204
higher and lower level React components useful for building Matrix communication
205205
apps using React.
206206

207207
After creating a new component you must run `yarn reskindex` to regenerate
208208
the `component-index.js` for the app (used in future for skinning).
209209

210-
Please note that Riot is intended to run correctly without access to the public
210+
Please note that Element is intended to run correctly without access to the public
211211
internet. So please don't depend on resources (JS libs, CSS, images, fonts)
212212
hosted by external CDNs or servers but instead please package all dependencies
213-
into Riot itself.
213+
into Element itself.
214214

215215
Setting up a dev environment
216216
============================
217217

218-
Much of the functionality in Riot is actually in the `matrix-react-sdk` and
218+
Much of the functionality in Element is actually in the `matrix-react-sdk` and
219219
`matrix-js-sdk` modules. It is possible to set these up in a way that makes it
220220
easy to track the `develop` branches in git and to make local changes without
221221
having to manually rebuild each time.
@@ -243,7 +243,7 @@ yarn install
243243
popd
244244
```
245245

246-
Finally, build and start Riot itself:
246+
Finally, build and start Element itself:
247247

248248
```bash
249249
git clone https://github.com/vector-im/riot-web.git
@@ -299,12 +299,12 @@ ___
299299
When you make changes to `matrix-react-sdk` or `matrix-js-sdk` they should be
300300
automatically picked up by webpack and built.
301301

302-
If you add or remove any components from the Riot skin, you will need to rebuild
302+
If you add or remove any components from the Element skin, you will need to rebuild
303303
the skin's index by running, `yarn reskindex`.
304304

305305
If any of these steps error with, `file table overflow`, you are probably on a mac
306306
which has a very low limit on max open files. Run `ulimit -Sn 1024` and try again.
307-
You'll need to do this in each new terminal you open before building Riot.
307+
You'll need to do this in each new terminal you open before building Element.
308308

309309
Running the tests
310310
-----------------

0 commit comments

Comments
 (0)