Renaming usergrid.json in the example
Since the code in the module crawls the app folders including node_modules
to find a file named usergrid.json or config.json, the config.json under
the examples gets read and may overwrite the app specific configs for the
usergrid.
With this change, if a user is intending to run the example code, they
will need to rename the related config
"/example/api-proxy/config/usergrid.example.json" to
"/example/api-proxy/config/usergrid.json".
diff --git a/examples/api-proxy/README.md b/examples/api-proxy/README.md
new file mode 100644
index 0000000..db03d0a
--- /dev/null
+++ b/examples/api-proxy/README.md
@@ -0,0 +1,4 @@
+To use this example, rename the `usergrid.example.json` to `usergrid.json`.
+This file is located at `examples/api-proxy/config`.
+
+**Note:** The usergrid module crawls your App file structure to find files named `usergrid.json` or a `config.json`. If there are multiple files with one of these names present at different locations under the app, only one of them will be used and the others are ignored. This may cause use of an unintended backend.
diff --git a/examples/api-proxy/config/usergrid.json b/examples/api-proxy/config/usergrid.example.json
similarity index 100%
rename from examples/api-proxy/config/usergrid.json
rename to examples/api-proxy/config/usergrid.example.json
