Add possibility to modifiy API_HOST using env variables

[arvados-workbench2.git] / README.md

diff --git a/README.md b/README.md
index bfeb1677adfa9f15d5217b3755018de4f28d9e8d..864a54fa89a122aab17afffa18d9828e3de0c050 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,40 @@
+[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 test</code>
+### Run tests
+<pre>
+yarn install
+yarn test
+</pre>
+
+### Production build
+<pre>
+yarn install
+yarn build
+</pre>
+
+### Configuration
+You can customize project global variables using env variables. Default values are placed in the `.env` file.
+
+Example:
+```
+REACT_APP_ARVADOS_API_HOST=localhost:8000 yarn start
+```
+
+### Licensing
 
-##### Production build
-<code>yarn build</code>
+Arvados is Free Software. See COPYING for information about Arvados Free
+Software licenses.