From 715bda61ca0e8fef417747ae10f78abe49f8ed64 Mon Sep 17 00:00:00 2001 From: Rhys Bartels-Waller Date: Tue, 3 May 2016 20:15:07 +1000 Subject: [PATCH] Update README with CircleCI badge, plus more content Also standardises the title and formatting of subtitle --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a13c154..86ab736 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -# Space.logging.Winston -_A production-grade logging adapter for [Space](http://www.github.com/meteor-space)_ +# space:winston [![Circle CI](https://circleci.com/gh/meteor-space/winston.svg?style=svg)](https://circleci.com/gh/meteor-space/winston) + +**A production-grade logging adapter for [Space](http://www.github.com/meteor-space)** This package adds a custom [Winston](https://github.com/winstonjs/winston) logger instance, that can be configured with your [Transport](https://github.com/winstonjs/winston/blob/master/docs/transports.md) of your choice via Space.Module configuration or dynamically using a simple API. It also sets up a [winston.transports.Console](https://github.com/winstonjs/winston/blob/master/docs/transports.md#console-transport) transport to log `info` messages if no custom transports are provided. @@ -102,6 +103,17 @@ Space.Application.define('MyApp', { }); ``` +## Contributing +In lieu of a formal styleguide, take care to maintain the existing coding style. +- Add unit / integration tests for any new or changed functionality. +- We use [git-flow](https://github.com/nvie/gitflow) so always branch from and target _develop_, which is the upcoming release of the package. + +[git-flow Cheat Sheet](http://danielkummer.github.io/git-flow-cheatsheet/) +[A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/) + +## Run the tests +`./test.sh` + ## Release History You can find the complete release history in the [changelog](https://github.com/meteor-space/winston/blob/master/CHANGELOG.md)