@nglogger/core/README.md

Pluggable logger for Angular 2 / 4 / 5

# @nglogger/core

[![Linux Build][travis-image]][travis-url]
[![Test Coverage][coveralls-image]][coveralls-url]
[![Commitizen friendly][commitizen-image]][commitizen-url]
[![NPM version][npm-v-image]][npm-url]
[![NPM Downloads][npm-dm-image]][npm-url]


Pluggable logger for Angular 2 / 4 / 5


--------------------------------------------------------------------------------


## Installation

```sh
$ npm install --save @nglogger/core
# Or with yarn
$ yarn add @nglogger/core
```


--------------------------------------------------------------------------------


## Usage

```ts
'use strict';
import { NgModule } from '@angular/core';

import { LoggerModule } from '@nglogger/core';


@NgModule({
  imports: [
    LoggerModule.forRoot([
      /** Transports */
    ])
  ],
  bootstrap: [
    AppComponent
  ]
})
export class AppModule { }
```

--------------------------------------------------------------------------------


## Build

```sh
$ npm install
$ # or
$ yarn
$
$ npm run build
```


--------------------------------------------------------------------------------

## Test

```sh
$ npm run test
```


--------------------------------------------------------------------------------

## Contributing

1. Fork it (<https://github.com/nglogger/core/fork>)
2. Create your feature branch (`git checkout -b feature/<feature_name>`)
3. Commit your changes (`git commit -am '<type>(<scope>): added some feature'`)
4. Push to the branch (`git push origin feature/<feature_name>`)
5. Create a new Pull Request


--------------------------------------------------------------------------------

## Contributors

- [SuperPaintman](https://github.com/SuperPaintman) SuperPaintman - creator, maintainer


--------------------------------------------------------------------------------

## Changelog
[Changelog][changelog-url]


--------------------------------------------------------------------------------

## License

[MIT][license-url]


[license-url]: https://raw.githubusercontent.com/nglogger/core/master/LICENSE
[changelog-url]: https://raw.githubusercontent.com/nglogger/core/master/CHANGELOG.md
[npm-url]: https://www.npmjs.com/package/@nglogger/core
[npm-v-image]: https://img.shields.io/npm/v/@nglogger/core.svg
[npm-dm-image]: https://img.shields.io/npm/dm/@nglogger/core.svg
[travis-image]: https://img.shields.io/travis/nglogger/core/master.svg?label=linux
[travis-url]: https://travis-ci.org/nglogger/core
[coveralls-image]: https://img.shields.io/coveralls/nglogger/core/master.svg
[coveralls-url]: https://coveralls.io/r/nglogger/core?branch=master
[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: https://commitizen.github.io/cz-cli/