Skip to content

Commit 2d0f502

Browse files
author
craig
committed
1.0.2 / 2021-07-21
================== * Updated README for config exports - @craigparra
1 parent 3bb2c7b commit 2d0f502

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

History.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
1.0.2 / 2021-07-21
2+
==================
3+
4+
* Updated README for config exports - @craigparra
5+
16
1.0.1 / 2021-07-20
27
==================
38

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ to negate the need for requiring and injecting the application config in every
2020
<a name="usage">Usage</a>
2121
-------------------------
2222

23-
To use the module, simply import the substituted config package as you would with the popular
24-
[config](https://www.npmjs.com/package/config) package, and `boot` it
23+
To use the module, substitute the named {config} module export, in place of the popular
24+
[config](https://www.npmjs.com/package/config) default, and `boot` it &ndash; note, we use a named export for config,
25+
because the module exports other useful classes as well.
2526

2627
```javascript
27-
const config = require('@alt-javascript/config');
28+
const {config} = require('@alt-javascript/config');
2829
const {LoggerFactory} = require('@alt-javascript/logger');
2930
const {boot} = require('@alt-javascript/boot');
3031

@@ -43,7 +44,7 @@ boot a WinstonLoggerFactory instead.
4344

4445
`MyApp.js`
4546
```javascript
46-
const config = require('@alt-javascript/config');
47+
const {config} = require('@alt-javascript/config');
4748
const winston = require('winston');
4849
const {LoggerFactory, WinstonLoggerFactory} = require('@alt-javascript/logger');
4950
const {boot} = require('@alt-javascript/boot');

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@alt-javascript/boot",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"description": "An Extensible Config & Logging Application Bootstrap Function",
55
"author": "Craig Parravicini",
66
"keywords": ["logging","configuration","boostrap","boot","global","context"],

0 commit comments

Comments
 (0)