Merge pull request #2491 from vector-im/rav/riot

s/vector/riot/ in the readme

README.md

@@ -1,52 +1,55 @@
-Vector/Web
+Riot
-==========
+====
 
-Vector is a Matrix web client built using the Matrix React SDK (https://github.com/matrix-org/matrix-react-sdk).
+Riot (formerly known as Vector) is a Matrix web client built using the Matrix
+React SDK (https://github.com/matrix-org/matrix-react-sdk).
 
 Getting Started
 ===============
 
-The easiest way to test Vector is to just use the hosted copy at https://vector.im/beta.
+The easiest way to test Riot is to just use the hosted copy at
-The develop branch is continuously deployed by Jenkins at https://vector.im/develop for
+https://riot.im/app.  The develop branch is continuously deployed by Jenkins at
-those who like living dangerously.
+https://riot.im/develop for those who like living dangerously.
 
-To host your own copy of Vector, the quickest bet is to use a pre-built released version
+To host your own copy of Riot, the quickest bet is to use a pre-built
-of Vector:
+released version of Riot:
 
 1. Download the latest version from https://vector.im/packages/
 1. Untar the tarball on your web server
 1. Move (or symlink) the vector-x.x.x directory to an appropriate name
 1. If desired, copy `config.sample.json` to `config.json` and edit it
    as desired. See below for details.
-1. Enter the URL into your browser and log into vector!
+1. Enter the URL into your browser and log into Riot!
 
 Important Security Note
 =======================
 
-We do not recommend running Vector from the same domain name as your Matrix
+We do not recommend running Riot from the same domain name as your Matrix
-homeserver.  The reason is the risk of XSS (cross-site-scripting) vulnerabilities
+homeserver.  The reason is the risk of XSS (cross-site-scripting)
-that could occur if someone caused Vector to load and render malicious user generated
+vulnerabilities that could occur if someone caused Riot to load and render
-content from a Matrix API which then had trusted access to Vector (or other apps) due
+malicious user generated content from a Matrix API which then had trusted
-to sharing the same domain.
+access to Riot (or other apps) due to sharing the same domain.
 
-We have put some coarse mitigations into place to try to protect against this situation,
+We have put some coarse mitigations into place to try to protect against this
-but it's still not good practice to do it in the first place.
+situation, but it's still not good practice to do it in the first place.  See
-See https://github.com/vector-im/vector-web/issues/1977 for more details.
+https://github.com/vector-im/vector-web/issues/1977 for more details.
 
 Building From Source
 ====================
 
-Vector is a modular webapp built with modern ES6 and requires a npm build system to build.
+Riot is a modular webapp built with modern ES6 and requires a npm build system
+to build.
 
 1. Install or update `node.js` so that your `npm` is at least at version `2.0.0`
 1. Clone the repo: `git clone https://github.com/vector-im/vector-web.git`
-1. Switch to the vector directory: `cd vector-web`
+1. Switch to the vector-web directory: `cd vector-web`
 1. Install the prerequisites: `npm install`
-1. If you are using the `develop` branch of vector, you will probably need to
+1. If you are using the `develop` branch of vector-web, you will probably need
-   rebuild one of the dependencies, due to https://github.com/npm/npm/issues/3055:
+   to rebuild one of the dependencies, due to
-   `(cd node_modules/matrix-react-sdk && npm install)`
+   https://github.com/npm/npm/issues/3055: `(cd node_modules/matrix-react-sdk
-1. Configure the app by copying `config.sample.json` to `config.json` and modifying
+   && npm install)`
-   it (see below for details)
+1. Configure the app by copying `config.sample.json` to `config.json` and
+   modifying it (see below for details)
 1. `npm run package` to build a tarball to deploy. Untaring this file will give
    a version-specific directory containing all the files that need to go on your
    web server.
@@ -102,14 +105,14 @@ You can configure the app by copying `vector/config.sample.json` to
 Running as a Desktop app
 ========================
 
-In future we'll do an official distribution of Vector as an desktop app.  Meanwhile,
+In future we'll do an official distribution of Riot as an desktop app.  Meanwhile,
 there are a few options:
 
 @asdf:matrix.org points out that you can use nativefier and it just works(tm):
 
 ```
 sudo npm install nativefier -g
-nativefier https://vector.im/beta/
+nativefier https://riot.im/app/
 ```
 
 krisa has a dedicated electron project at https://github.com/krisak/vector-electron-desktop
@@ -123,11 +126,11 @@ There's also a (much) older electron distribution at https://github.com/stevenha
 Development
 ===========
 
-Before attempting to develop on Vector you **must** read the developer guide
+Before attempting to develop on Riot you **must** read the developer guide
 for `matrix-react-sdk` at https://github.com/matrix-org/matrix-react-sdk, which
-also defines the design, architecture and style for Vector too.
+also defines the design, architecture and style for Riot too.
 
-The idea of Vector is to be a relatively lightweight "skin" of customisations on
+The idea of Riot is to be a relatively lightweight "skin" of customisations on
 top of the underlying `matrix-react-sdk`. `matrix-react-sdk` provides both the
 higher and lower level React components useful for building Matrix communication
 apps using React.
@@ -136,26 +139,26 @@ After creating a new component you must run `npm run reskindex` to regenerate
 the `component-index.js` for the app (used in future for skinning)
 
 **However, as of July 2016 this layering abstraction is broken due to rapid
-development on Vector forcing `matrix-react-sdk` to move fast at the expense of
+development on Riot forcing `matrix-react-sdk` to move fast at the expense of
-maintaining a clear abstraction between the two.**  Hacking on Vector inevitably
+maintaining a clear abstraction between the two.**  Hacking on Riot inevitably
 means hacking equally on `matrix-react-sdk`, and there are bits of
 `matrix-react-sdk` behaviour incorrectly residing in the `vector-web` project
-(e.g. matrix-react-sdk specific CSS), and a bunch of Vector specific behaviour
+(e.g. matrix-react-sdk specific CSS), and a bunch of Riot specific behaviour
-in the `matrix-react-sdk` (grep for Vector).  This separation problem will be
+in the `matrix-react-sdk` (grep for `vector` / `riot`).  This separation problem will be
-solved asap once development on Vector (and thus matrix-react-sdk) has
+solved asap once development on Riot (and thus matrix-react-sdk) has
 stabilised.  Until then, the two projects should basically be considered as a
 single unit.  In particular, `matrix-react-sdk` issues are currently filed
 against `vector-web` in github.
 
-Please note that Vector is intended to run correctly without access to the public
+Please note that Riot is intended to run correctly without access to the public
 internet.  So please don't depend on resources (JS libs, CSS, images, fonts)
 hosted by external CDNs or servers but instead please package all dependencies
-into Vector itself.
+into Riot itself.
 
 Setting up a dev environment
 ============================
 
-Much of the functionality in Vector is actually in the `matrix-react-sdk` and
+Much of the functionality in Riot is actually in the `matrix-react-sdk` and
 `matrix-js-sdk` modules. It is possible to set these up in a way that makes it
 easy to track the `develop` branches in git and to make local changes without
 having to manually rebuild each time.
@@ -178,7 +181,7 @@ Then similarly with `matrix-react-sdk`:
 1. `rm -r node_modules/matrix-js-sdk; ln -s ../../matrix-js-sdk node_modules/`
 1. `popd`
 
-Finally, build and start vector itself:
+Finally, build and start Riot itself:
 
 1. `git clone git@github.com:vector-im/vector-web.git`
 1. `cd vector-web`
@@ -203,19 +206,19 @@ Finally, build and start vector itself:
    Remember, the command will not terminate since it runs the web server
    and rebuilds source files when they change. This development server also
    disables caching, so do NOT use it in production.
-1. Open http://127.0.0.1:8080/ in your browser to see your newly built Vector.
+1. Open http://127.0.0.1:8080/ in your browser to see your newly built Riot.
 
 When you make changes to `matrix-react-sdk`, you will need to run `npm run
 build` in the relevant directory. You can do this automatically by instead
 running `npm start` in the directory, to start a development builder which
 will watch for changes to the files and rebuild automatically.
 
-If you add or remove any components from the Vector skin, you will need to rebuild
+If you add or remove any components from the Riot skin, you will need to rebuild
 the skin's index by running, `npm run reskindex`.
 
 If any of these steps error with, `file table overflow`, you are probably on a mac
 which has a very low limit on max open files. Run `ulimit -Sn 1024` and try again.
-You'll need to do this in each new terminal you open before building vector.
+You'll need to do this in each new terminal you open before building Riot.
 
 Filing issues
 =============
@@ -247,23 +250,3 @@ bug or feature:
 
      * network (specific to network conditions)
      * platform (platform specific)
-
-Enabling encryption
-===================
-
-End-to-end encryption in Vector and Matrix is not yet considered ready for
-day-to-day use; it is experimental and should be considered only as a
-proof-of-concept. See https://matrix.org/jira/browse/SPEC-162 for an overview
-of the current progress.
-
-To enable the (very experimental) support, check the 'End-to-End Encryption'
-box in the 'Labs' section of the user settings (note that the labs are disabled
-on http://vector.im/beta: you will need to use http://vector.im/develop or your
-own deployment of vector). The Room Settings dialog will then show an
-'Encryption' setting; rooms for which you are an administrator will offer you
-the option of enabling encryption. Any messages sent in that room will then be
-encrypted.
-
-Note that historical encrypted messages cannot currently be decoded - history
-is therefore lost when the page is reloaded.
-