Scribe.js/README.md
2014-12-25 19:39:34 +01:00

41 lines
1.3 KiB
Markdown

![Logo](https://raw.githubusercontent.com/bluejamesbond/Scribe.js/master/__misc/scribejs%20design%20logo%20%5Ba%5D.png)
**Lightweight NodeJS Logging**
#Overview
![webPanel](__misc/webPanelDemo.gif)
*Web Panel*
![terminal](__misc/terminalDemo.png)
*Terminal*
Unlike many of the libraries out there, Scribe.js allows logging on multiple files and is divided into folders by date. And it is possibly the easiest logging you can implement.
##Features
- Allows you to use the `console` object (which provides easy integration with existing systems)
- Save messages into JSON log files organized by user, date, and type or your custom rule
- Print messages into console using customized colors (to indicate level of importance)
- Adding context to logs such as time, tags, filename and line number
- Handles logging Objects / Arrays
- Log Express.js requests
- Provides a developer API to access your logs
- Features a rich HTML web panel to access logs from anywhere in the world
#Live Demo
You can access a live demo of the library [here](https://bluejamesbond.github.io/Scribe.js/).
#Wiki
For examples, tests, and API refer to the [Scribe.js Wiki](https://github.com/bluejamesbond/Scribe.js/wiki).
#Installation
```
npm install scribe-js
```
#Contributors
- [bluejamesbond](https://github.com/bluejamesbond)
- [guillaumewuip](https://github.com/guillaumewuip)