From ef00bc6d5646292694169c5c61beab5871baab7d Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 24 Feb 2016 11:59:29 +0000 Subject: [PATCH] Manually merge relevant remaining parts of https://github.com/vector-im/vector-web/pull/790 that aren't covered by @richvdh's PR. --- AUTHORS.rst | 3 +++ README.md | 13 +++++++++++++ 2 files changed, 16 insertions(+) diff --git a/AUTHORS.rst b/AUTHORS.rst index 8617b589..c08ad5e6 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -7,3 +7,6 @@ include: * https://github.com/neko259 Improved scrollbar CSS + +* Florent VIOLLEAU (https://github.com/floviolleau) + Improve README.md for a better understanding of installation instructions diff --git a/README.md b/README.md index 6172341c..48142bcc 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,19 @@ With `npm start`, any changes you make to the source files will cause a rebuild your changes will show up when you refresh. This development server also disables caching, so do NOT use it in production. +Configuring +=========== + +Configure the app by modifying the `config.json` file: + +1. `default_hs_url` is the default home server url. +1. `default_is_url` is the default identity server url (this is the server used + for verifying third party identifiers like email addresses). If this is blank, + registering with an email address or adding an email address to your account + will not work. + +You will need to re-run `npm run build` after editing `config.json`. + Deployment ==========