From edbef77114dfde33524dccb22d27144570299372 Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Thu, 26 Jan 2017 13:41:13 +0100 Subject: Add config instructions to README --- README.md | 4 +++- sample_config.json | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 sample_config.json diff --git a/README.md b/README.md index 22a173ae..84ed0e99 100644 --- a/README.md +++ b/README.md @@ -14,5 +14,7 @@ Run the following commands from this directory to fetch dependencies and compile ``` $ yarn -$ gulp +$ gulp --config=config.json ``` + +**Note:** You need to replace `config.json` with the name / path of a real config file. This config file can be created by making a copy of the `sample_config.json` template and replacing the entries with your setup data. Make sure not to check this new config file into the VCS, as it is unique to each deployment situation. diff --git a/sample_config.json b/sample_config.json new file mode 100644 index 00000000..628476ed --- /dev/null +++ b/sample_config.json @@ -0,0 +1,3 @@ +{ + "GOOGLE_OAUTH_CLIENT_ID": "the-google-oauth-client-id" +} -- cgit v1.2.3