From 217f062b5e54ce7060ec2335d717f4ae6bf8086d Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Sun, 7 May 2023 13:48:32 +0700 Subject: [PATCH] Readme tweaks --- readme.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 80c0d5b..778b763 100644 --- a/readme.md +++ b/readme.md @@ -104,6 +104,8 @@ config.set('foo', '1'); Type: `object` +**Important: I cannot provide support for this feature. It has some known bugs. I have no plans to work on it, but pull requests are welcome.** + You can use migrations to perform operations to the store whenever a **project version** is upgraded. The `migrations` object should consist of a key-value pair of `'version': handler`. The `version` can also be a [semver range](https://github.com/npm/node-semver#ranges). @@ -442,7 +444,7 @@ Example using YAML: ```js import Conf from 'conf'; -const yaml = require('js-yaml'); +import yaml from 'js-yaml'; const config = new Conf({ projectName: 'foo',