Merge branch 'master' into 14452-my-account

[arvados-workbench2.git] / README.md

diff --git a/README.md b/README.md
index 4cfe3845cbe050884a2fd0a6b165b91b9d4022e3..e8d77701107179a6ef88fcfb68cd47d857a321a9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,55 @@
+[comment]: # (Copyright © The Arvados Authors. All rights reserved.)
+[comment]: # ()
+[comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0)
+
 ## Arvados Workbench 2
 
-##### Setup
+### Setup
 <pre>
 brew install yarn
 yarn install
 </pre>
 Install [redux-devtools-extension](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd)
 
-##### Start project
+### Start project
 <code>yarn start</code>
 
-##### Run tests
-<code>yarn install</code>
-<code>yarn test</code>
+### Run tests
+<pre>
+yarn install
+yarn test
+</pre>
+
+### Production build
+<pre>
+yarn install
+yarn build
+</pre>
+
+### Build time configuration
+You can customize project global variables using env variables. Default values are placed in the `.env` file.
+
+Example:
+```
+REACT_APP_ARVADOS_CONFIG_URL=config.json yarn build
+```
+
+### Run time configuration
+The app will fetch runtime configuration when starting. By default it will try to fetch `/config.json`. You can customize this url using build time configuration.
+
+Currently this configuration schema is supported:
+```
+{
+    "API_HOST": "string",
+    "VOCABULARY_URL": "string"
+}
+```
+
+#### VOCABULARY_URL
+Local path, or any URL that allows cross-origin requests. See 
+[Vocabulary JSON file example](public/vocabulary-example.json).
+
+### Licensing
 
-##### Production build
-<code>yarn install</code>
-<code>yarn build</code>
+Arvados is Free Software. See COPYING for information about Arvados Free
+Software licenses.