Skip to content
Snippets Groups Projects
Commit 4cf536c3 authored by admin-sigmundd's avatar admin-sigmundd
Browse files

Nicer Readme

parent 65525d90
Branches
Tags
1 merge request!1Update index.test.js, examples/all-options.js, examples/log-to-file.js,...
...@@ -8,14 +8,20 @@ A real simple logger application ...@@ -8,14 +8,20 @@ A real simple logger application
## Usage ## Usage
`const log = require('log')(options)` `const log = require('log')(options)`
Note: The options Part may be omitted, as all parts are optional, but using the name is recommended, as without it, the folder-name will be used Note: The options Part may be omitted, as all parts are optional, but using the name is recommended, as without it, the folder-name will be used
Options: ### Methods
`log.info('This is an Information')`
`log.warn('This is a Warning')`
`log.error('This is an Error')`
`log.debug('This is a Debug Message')`
### Options
```json
{ {
name: 'Name of App', name: 'Name of App',
hostname: 'Server Hostname', hostname: 'Server Hostname',
...@@ -27,3 +33,4 @@ Options: ...@@ -27,3 +33,4 @@ Options:
} }
] ]
} }
```
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment