Contributing

If you want to contribute to coding, check this pending tasks:

• Implement async methods
• Implement object options in constructor, instead defaultLogLevel and version
• Save the loggers to offer them with a get methods, like Loggerage.getLogger('NAME_LOGGER')
• Implement get log by query system
• Implement method or property that promisify all async methods automatically (see loggerage-promisify)
• Implement getStreamLog method
• Develop storages for different scenarios (like mysql, files log, etc)
• Allow multiple storage (appendStorage method, for example)
• Test, more test

Run test

$ npm install && npm test

Documentation

This doc is built thanks to MkDocs. For contributing in doc, you must install mkdocs (with python) and install markdown-checklist.extension also.

Instructions

• Clone the loggerage repository if you have not done it before:

$ git clone https://github.com/lmfresneda/loggerage.git
$ cd loggerage

• Clone again but this time the 'gh-pages' branch in the 'site' folder

$ git clone -b gh-pages --single-branch https://github.com/lmfresneda/loggerage.git ./site/

• Your project looks like this now:

...
src/
docs/
site/ <-- created by second clone
...
package.json
...

In docs folder are the complete documentation in Markdown format, and this is where you will work. When you building de page with the command mkdocs build, a site folder is updated.

• Happy doc!