diff --git a/README.md b/README.md index 2dba117290c98ae127407099b1f7cb8471c64474..b7208c6a19bef44ba36e644778b27b2ab61c0970 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,28 @@ It reads from the following sources, performing a deep merge: - config.json - config.defaults.json +## Examples + +### Only config.defaults.json + +`node examples/only-defaults/index.js` + +### Only config.json + +(Kind of legacy use) + +`node examples/only-local/index.js` + +### defaults and config.json + +`node examples/defaults-overwrite/index.js` + +### enviroment variables + +(Enviroment set by command to not pollute your machine) + +`setting=overwritten-by-env node examples/env/index.js` + ## TODO / Missing - hashicorp values support: if value == "vault:", treat it as secret diff --git a/examples/env/config.defaults.json b/examples/env/config.defaults.json index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..8d6cd811d747774867ebb052b1f264b09b099627 100644 --- a/examples/env/config.defaults.json +++ b/examples/env/config.defaults.json @@ -0,0 +1,6 @@ +{ + "setting":"value", + "another": { + "setting":"avalue" + } +} \ No newline at end of file diff --git a/examples/env/config.json b/examples/env/config.json index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..de6fd1fe02c2f854e2de807c717277de3d25b5e5 100644 --- a/examples/env/config.json +++ b/examples/env/config.json @@ -0,0 +1,6 @@ +{ + "setting":"overwritten", + "another": { + "more":"settings" + } +} \ No newline at end of file diff --git a/examples/env/index.js b/examples/env/index.js index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..798f2f4e316f7b522d0f9c53dbaee3fe3fe0d458 100644 --- a/examples/env/index.js +++ b/examples/env/index.js @@ -0,0 +1,3 @@ +let config = require('../../index') + +console.log(JSON.stringify(config, undefined, 2)) \ No newline at end of file diff --git a/examples/env/server.env b/examples/env/server.env deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000 diff --git a/examples/only-local/config.json b/examples/only-local/config.json new file mode 100644 index 0000000000000000000000000000000000000000..8d6cd811d747774867ebb052b1f264b09b099627 --- /dev/null +++ b/examples/only-local/config.json @@ -0,0 +1,6 @@ +{ + "setting":"value", + "another": { + "setting":"avalue" + } +} \ No newline at end of file diff --git a/examples/only-local/index.js b/examples/only-local/index.js new file mode 100644 index 0000000000000000000000000000000000000000..798f2f4e316f7b522d0f9c53dbaee3fe3fe0d458 --- /dev/null +++ b/examples/only-local/index.js @@ -0,0 +1,3 @@ +let config = require('../../index') + +console.log(JSON.stringify(config, undefined, 2)) \ No newline at end of file