From 5d8b246ef1d2a778f26b1633aabd115ed82ace06 Mon Sep 17 00:00:00 2001 From: Resynth Date: Fri, 17 Jul 2020 11:28:10 +0000 Subject: [PATCH] Update native-node-modules.md --- docs/native-node-modules.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/native-node-modules.md b/docs/native-node-modules.md index 8daa51f93e..850573e389 100644 --- a/docs/native-node-modules.md +++ b/docs/native-node-modules.md @@ -1,24 +1,24 @@ # Native Node Modules -For some features, the desktop version of Riot can make use of native Node +For some features, the desktop version of Element can make use of native Node modules. These allow Riot to integrate with the desktop in ways that a browser cannot. While native modules enable powerful new features, they must be complied for -each operating system. For official Riot releases, we will always build these +each operating system. For official Element releases, we will always build these modules from source to ensure we can trust the compiled output. In the future, we may offer a pre-compiled path for those who want to use these features in a -custom build of Riot without installing the various build tools required. +custom build of Element without installing the various build tools required. Do note that compiling a module for a particular operating system (Linux/macOS/Windows) will need to be done on that operating system. Cross-compiling from a host OS for a different target OS may be possible, but -we don't support this flow with Riot dependencies at this time. +we don't support this flow with Element dependencies at this time. -At the moment, we need to make some changes to the Riot release process before +At the moment, we need to make some changes to the Element release process before we can support native Node modules at release time, so these features are currently disabled by default until that is resolved. The following sections -explain the manual steps you can use with a custom build of Riot to enable +explain the manual steps you can use with a custom build of Element to enable these features if you'd like to try them out. ## Adding Seshat for search in E2E encrypted rooms @@ -53,7 +53,7 @@ Please make sure to include all the `--` as well as the `--release` command line switch at the end. Modify your electron version accordingly depending on the version that is installed on your system. -After this is done the Electron version of Riot can be run from the main folder +After this is done the Electron version of Element can be run from the main folder as usual using: yarn electron