Scribe.js/README.md

44 lines
1.5 KiB
Markdown
Raw Normal View History

2015-01-13 11:59:53 -06:00
[![Build Status](https://travis-ci.org/bluejamesbond/Scribe.js.svg?branch=master)](https://travis-ci.org/bluejamesbond/Scribe.js)
2014-12-25 03:19:24 -06:00
![Logo](https://raw.githubusercontent.com/bluejamesbond/Scribe.js/master/__misc/scribejs%20design%20logo%20%5Ba%5D.png)
2014-12-20 15:16:54 +01:00
2014-08-01 02:32:30 -05:00
**Lightweight NodeJS Logging**
2014-12-20 15:16:54 +01:00
2014-12-25 03:19:24 -06:00
#Overview
2014-12-20 15:16:54 +01:00
2014-12-25 13:10:40 -06:00
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.
2014-12-25 13:10:40 -06:00
##WebPanel
![webPanel](__misc/webPanelDemo.gif)
2014-12-20 19:52:12 +01:00
2014-12-25 13:10:40 -06:00
##Terminal
![terminal](__misc/terminalDemo.png)
2014-12-20 19:52:12 +01:00
2014-12-25 03:19:24 -06:00
##Features
2014-12-20 19:52:12 +01:00
2014-12-25 03:19:24 -06:00
- 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
2014-12-20 19:52:12 +01:00
2014-12-25 03:19:24 -06:00
#Live Demo
2014-12-25 03:19:46 -06:00
You can access a live demo of the library [here](https://bluejamesbond.github.io/Scribe.js/).
2014-12-20 19:52:12 +01:00
2014-12-25 03:19:24 -06:00
#Wiki
2014-12-20 19:52:12 +01:00
2014-12-25 11:50:21 -06:00
For examples, tests, and API refer to the [Scribe.js Wiki](https://github.com/bluejamesbond/Scribe.js/wiki).
2014-08-01 02:32:30 -05:00
2014-12-25 03:19:24 -06:00
#Installation
2014-08-01 02:32:30 -05:00
```
2014-12-25 03:44:24 -06:00
npm install scribe-js
2014-08-01 02:32:30 -05:00
```
2014-12-20 15:16:54 +01:00
#Contributors
2014-12-20 15:35:12 +01:00
- [bluejamesbond](https://github.com/bluejamesbond)
2014-12-25 03:19:24 -06:00
- [guillaumewuip](https://github.com/guillaumewuip)