@dxos/config 2.32.1-dev.77d63563 → 2.32.1-dev.b05915c7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/config",
-  "version": "2.32.1-dev.77d63563",
+  "version": "2.32.1-dev.b05915c7",
   "description": "Config utilities",
   "license": "MIT",
   "author": "DXOS.org",
@@ -12,10 +12,10 @@
     "webpack-plugin.js"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "2.32.1-dev.77d63563",
-    "@dxos/debug": "2.32.1-dev.77d63563",
-    "@dxos/protocols": "2.32.1-dev.77d63563",
-    "@dxos/util": "2.32.1-dev.77d63563",
+    "@dxos/codec-protobuf": "2.32.1-dev.b05915c7",
+    "@dxos/debug": "2.32.1-dev.b05915c7",
+    "@dxos/protocols": "2.32.1-dev.b05915c7",
+    "@dxos/util": "2.32.1-dev.b05915c7",
     "boolean": "^3.0.1",
     "debug": "^4.3.3",
     "js-yaml": "^4.1.0",
@@ -51,6 +51,5 @@
     "build:test": "toolchain build:test",
     "lint": "toolchain lint",
     "test": "toolchain test"
-  },
-  "readme": "\n# @dxos/config\n> DXOS config\n\nLoad configuration using a simple config folder structure.\n\n\n## Install\n\n```\n$ npm install @dxos/config\n```\n\n## Usage\n\nWe have a config folder with yml files:\n\n```\nconfig/\n├── config.yml\n├── defaults.yml\n└── envs-map.yml\n\n```\n\nEach file is mapped to its owns type :\n\n```\nDynamics() -> config.yml\nEnvs() -> envs-map.yml\nDefaults() -> defaults.yml\n```\n\nThe `Dynamics()` config.yml file is *special*, it will be loaded if the `dynamic` property is set to `false`.\nIf `dynamic` is set to `true` each app will try to load from an endpoint (using `{publicUrl}/config/config.json`),\n`wire app serve` adds config endpoints for each app serving the global config file (`~/.wire/remote.yml`).\n\nAlso the `envs-map.yml` is *special*. It provides a map between `process.env` vars and the config paths:\n\n```\nPUBLIC_URL:\n  path: app.publicUrl\nNODE_ENV:\n  path: debug.mode\nDEBUG:\n  path: debug.logging\n\n```\n\n> For web a project with webpack is required.\n\n- Add the `ConfigPlugin` to your webpack plugins (web-only):\n\n```js\nconst { ConfigPlugin } = require('@dxos/config/ConfigPlugin');\n\n//...\n\nplugins: [\n  new ConfigPlugin({\n    // PATH TO CONFIG FOLDER\n    path: path.resolve(__dirname, 'config'),\n    dynamic: process.env.CONFIG_DYNAMIC\n  }),\n]\n\n```\n\n- Load your configs:\n\n```js\nconst { Config, LocalStorage, Dynamics, Envs, Defaults } from '@dxos/config`;\n\nexport const config = async () => new Config(\n  LocalStorage(),\n  await Dynamics(),\n  Envs(),\n  Defaults()\n)\n\n```\n\n> Note that config is a function and it should be *awaited*!!!\n\n## API\n\n...\n\n## Contributing\n\nPRs accepted.\n\n## License\n\nGPL-3.0 © dxos\n"
+  }
 }