Browse Source

renamed to mlogger to avoid name conflicts

master
mort 8 years ago
parent
commit
8b69fe9b41
2 changed files with 13 additions and 13 deletions
  1. 11
    11
      README.md
  2. 2
    2
      package.json

+ 11
- 11
README.md View File

@@ -1,6 +1,6 @@
# Logger
# mLogger

Logger is a very simple logging library for node.js.
mLogger is a very simple logging library for node.js.

## Installation

@@ -13,24 +13,24 @@ npm install --save logger
## Usage

```
var logger = require("logger");
var log = require("mlogger");
```

Logger has 4 methods for logging:

```
logger.info("foo"); // yyyy/mm/dd HH:MM:SS INFO: foo
logger.notice("foo"); // yyyy/mm/dd HH:MM:SS NOTICE: foo
logger.warn("foo"); // yyyy/mm/dd HH:MM:SS WARNING: foo
logger.die("foo"); // yyyy/mm/dd HH:MM:SS ERROR: foo
log.info("foo"); // yyyy/mm/dd HH:MM:SS INFO: foo
log.notice("foo"); // yyyy/mm/dd HH:MM:SS NOTICE: foo
log.warn("foo"); // yyyy/mm/dd HH:MM:SS WARNING: foo
log.die("foo"); // yyyy/mm/dd HH:MM:SS ERROR: foo
```

After logger.die, the process will immediately exit.
After log.die, the process will immediately exit.

If an error object is passed instead of a string, a stack trace will be printed, like this:

```
logger.notice(new Error("foo"));
log.notice(new Error("foo"));

// yyyy/mm/dd HH:MM:SS NOTICE: foo - stack trace:
// Trace: [Error: foo]
@@ -40,7 +40,7 @@ logger.notice(new Error("foo"));
To set a different color theme, use `setTheme`:

```
logger.setTheme({
log.setTheme({
timestamp: "green"
})
```
@@ -53,4 +53,4 @@ The available properties for setTheme is:
* level_2: logger.warn, default: "red"
* level_3: logger.die, default: ["bold", "red"]

The available values for themes are listed here: npmjs.com/package/colors
The available values for themes are listed here: https://npmjs.com/package/colors

+ 2
- 2
package.json View File

@@ -1,5 +1,5 @@
{
"name": "logger",
"name": "mlogger",
"version": "1.0.0",
"description": "Tiny logging library for node.js.",
"main": "index.js",
@@ -17,6 +17,6 @@
},
"repository": {
"type": "git",
"url": "http://git.mort.coffee/mort/logger"
"url": "http://git.mort.coffee/mort/mlogger"
}
}

Loading…
Cancel
Save