From 4f5e3f6c751d7e3899f5a7e773e71196bdbe7e15 Mon Sep 17 00:00:00 2001 From: Joel Purra Date: Sun, 11 Jun 2023 23:04:38 +0200 Subject: [PATCH] Update links --- README.md | 33 +++++++++++++++++++-------------- package.json | 2 +- 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b3d39fa..227b4dd 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# [nodejs-configvention](https://github.com/joelpurra/nodejs-configvention) - -https://github.com/joelpurra/nodejs-configvention +# [nodejs-configvention](https://joelpurra.com/projects/nodejs-configvention/) A node.js *configuration convention* with a minimal readonly interface. Reads configuration values from the environment, arguments, override configuration file, defaults configuration file. +Available from [npm](https://www.npmjs.com/) as [`configvention`](https://www.npmjs.com/package/configvention). + ## Usage @@ -22,13 +22,6 @@ var something = configuration.get("something"); npm install --save configvention@latest ``` -- Configvention >= v3.0.0: - - [ECMAScript Module](https://nodejs.org/dist/latest/docs/api/esm.html) (ESM) [package](https://nodejs.org/dist/latest/docs/api/packages.html). - - For use with [Node.js v16 or later](https://github.com/nodejs/release). -- Configvention <= [v2.0.0](https://www.npmjs.com/package/configvention?activeTab=versions): - - [CommonJS](https://nodejs.org/dist/latest/docs/api/modules.html) (CJS) legacy package. - - For use with all (?) Node.js versions. - ## Convention @@ -57,13 +50,25 @@ DEBUG='configvention:*' node my-app.js ``` + +## Versions + +For details, see [git commits](https://github.com/joelpurra/nodejs-configvention/commits), [git tags](https://github.com/joelpurra/nodejs-configvention/tags) and [published npm versions](https://www.npmjs.com/package/configvention?activeTab=versions). + + +- Configvention >= v3.0.0: + - [ECMAScript Module](https://nodejs.org/dist/latest/docs/api/esm.html) (ESM) [package](https://nodejs.org/dist/latest/docs/api/packages.html). + - For use with [Node.js v16 or later](https://github.com/nodejs/release). +- Configvention <= v2.0.0: + - [CommonJS](https://nodejs.org/dist/latest/docs/api/modules.html) (CJS) legacy package. + - For use with all (?) Node.js versions. + ## Alternatives Some alternatives found glancing over npm modules [dependent](https://npmjs.org/browse/depended/nconf) on [nconf](https://npmjs.org/package/nconf). -> - [nconfs](https://npmjs.org/package/nconfs) node.js convention/library for multiple nconf settings. - -> - [reconf](https://npmjs.org/package/reconf) Recursive configuration file management with defaults and overrides for nconf. +- [nconfs](https://npmjs.org/package/nconfs): node.js convention/library for multiple nconf settings. +- [reconf](https://npmjs.org/package/reconf): Recursive configuration file management with defaults and overrides for nconf. @@ -72,5 +77,5 @@ Some alternatives found glancing over npm modules [dependent](https://npmjs.org/ Copyright (c) 2012, 2016, [Joel Purra](https://joelpurra.com/) All rights reserved. -When using [nodejs-configvention](https://github.com/joelpurra/nodejs-configvention), comply to at least one of the three available licenses: MIT, BSD-2-Clause, GPL-3.0. +When using [nodejs-configvention](https://joelpurra.com/projects/nodejs-configvention/), comply to at least one of the three available licenses: MIT, BSD-2-Clause, GPL-3.0. Please see the LICENSE file for details. diff --git a/package.json b/package.json index 5caebfe..24bd4e6 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "email": "code+npm@joelpurra.com", "url": "https://joelpurra.com/" }, - "homepage": "https://github.com/joelpurra/nodejs-configvention", + "homepage": "https://joelpurra.com/projects/nodejs-configvention/", "description": "Configuration convention with a minimal readonly interface.", "exports": "./lib/configvention.js", "repository": {