Skip to content

Commit

Permalink
Add Config variables section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Mouhajer-CO committed Nov 27, 2023
1 parent 7a6cdc1 commit 095b9f7
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ The logger module integrates other best practice configurations and tools, such
npm i @co-digital/logging
```

### Config variables

Following configs will need to be added as environment variables to the application

Key | Description | Example Value | Required |
----------------|--------------------------- |------------------------- |---------- |
LOG_LEVEL | Logging levels | `info` (Log only if info.level is less than or equal to this level) | True |
HUMAN | Formatting messages form (default JSON) | `true` (Enable human formatting for log messages) | False |

## Files Structure

Directory Path | Description
Expand Down

0 comments on commit 095b9f7

Please sign in to comment.