@ncfour-us/logging 0.0.18 → 0.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +52 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,7 +1,44 @@
1
- # @cnfour-us/logging
1
+ # @ncfour-us/logging
2
2
 
3
3
  This project implements a simple logger and a proxy for winston logger.
4
4
 
5
+ ## Badges
6
+
7
+ ![GitHub top language](https://img.shields.io/github/languages/top/ncfour-us/logging?logo=typescript)
8
+ ![GitHub License](https://img.shields.io/github/license/ncfour-us/logging?logo=github)
9
+ ![GitHub Release](https://img.shields.io/github/v/release/ncfour-us/logging?logo=github)
10
+ ![GitHub commit activity](https://img.shields.io/github/commit-activity/t/ncfour-us/logging?logo=github)
11
+ ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-raw/ncfour-us/logging?logo=github)
12
+ ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/ncfour-us/logging?logo=github)
13
+
14
+ <!--
15
+ ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ncfour-us/logging/release.yml?label=release&logo=github)
16
+ ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ncfour-us/logging/upgrade-main.yml?label=upgrade-main&logo=github)
17
+ -->
18
+
19
+ ![NPM Version](https://img.shields.io/npm/v/%40ncfour-us%2Flogging?logo=npm)
20
+ ![NPM Last Update](https://img.shields.io/npm/last-update/%40ncfour-us%2Flogging?logo=npm)
21
+ ![NPM Downloads](https://img.shields.io/npm/dw/%40ncfour-us%2Flogging?logo=npm)
22
+
23
+ ## Table of Contents
24
+
25
+ - [Installation](#installation)
26
+ - [Getting Started](#getting-started)
27
+ - [Contributing](#contributing)
28
+ - [License](#license)
29
+ - [Authors](#authors)
30
+ - [Acknowledgements](#acknowledgements)
31
+
32
+ ## Installation
33
+
34
+ Install using `npm`, `yarn`, or `pnpm` (preferred).
35
+
36
+ ```bash
37
+ pnpm add @ncfour-us/logging
38
+ ```
39
+
40
+ ## Getting Started
41
+
5
42
  The package exports an `ILogger` interface along with a `createLogger()` function.
6
43
 
7
44
  The return value from `createLogger()` is a `ILogger` which can then be used
@@ -16,3 +53,17 @@ import { ILogger, createLogger } from '@ncfour-us/logging';
16
53
 
17
54
  const myLogger: ILogger = createLogger('simple');
18
55
  ```
56
+
57
+ ## Contributing
58
+
59
+ Fork this repository and submit a PR.
60
+
61
+ ## Authors
62
+
63
+ - Tim Hahn ([hahntj@gmail.com](mailto:hahntj@gmail.com), github: @climbertjh)
64
+
65
+ ## License
66
+
67
+ The project is covered by the MIT license, see [LICENSE](./LICENSE).
68
+
69
+ ## Acknowledgements
package/package.json CHANGED
@@ -58,7 +58,7 @@
58
58
  },
59
59
  "main": "lib/index.js",
60
60
  "license": "MIT",
61
- "version": "0.0.18",
61
+ "version": "0.0.20",
62
62
  "jest": {
63
63
  "coverageProvider": "v8",
64
64
  "extensionsToTreatAsEsm": [