From 14340d29c0c4901696030512887c0f5f1f61b004 Mon Sep 17 00:00:00 2001 From: Dominik Sigmund <dominik.sigmund@br.de> Date: Thu, 20 Feb 2020 11:17:05 +0100 Subject: [PATCH] Update README.md --- README.md | 68 +++++++++++++++++++++++++++---------------------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index f9752be..9757201 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,35 @@ -# log.js - -A real simple logger application. -May Optional Log to A File. - -## Installation -`npm install --save git+ssh://git@it-devops-01.br-edv.brnet.int:argos/log.git` - -## Usage - -`const Log = require('log')` -`let log = new Log(options)` - -Note: The options Part may be omitted, as all parts are optional, but using the name is recommended, as without it, the package-name will be used - -### Methods - -* `log.info('This is an Information' )` -* `log.notice('This is a Notice' )` -* `log.warn('This is a Warning' )` -* `log.error('This is an Error' )` -* `log.fatal('This is a Fatal Message' )` -* `log.debug('This is a Debug Message' )` - -### Options - -```json -{ - name: 'Name of App. Default: Name of BaseFolder', - hostname: 'Server Hostname, Default: os.hostname()', - file: 'File to Append Log to', - path: 'Path Logfile located', - loglevel: 'Minimal LogLevel. Default: WARN' -} +# log.js + +A real simple logger application. +May Optional Log to A File. + +## Installation +`npm install --save git+https://it-devops-01.br-edv.brnet.int/argos/log.git` + +## Usage + +`const Log = require('log')` +`let log = new Log(options)` + +Note: The options Part may be omitted, as all parts are optional, but using the name is recommended, as without it, the package-name will be used + +### Methods + +* `log.info('This is an Information' )` +* `log.notice('This is a Notice' )` +* `log.warn('This is a Warning' )` +* `log.error('This is an Error' )` +* `log.fatal('This is a Fatal Message' )` +* `log.debug('This is a Debug Message' )` + +### Options + +```json +{ + name: 'Name of App. Default: Name of BaseFolder', + hostname: 'Server Hostname, Default: os.hostname()', + file: 'File to Append Log to', + path: 'Path Logfile located', + loglevel: 'Minimal LogLevel. Default: WARN' +} ``` \ No newline at end of file -- GitLab