Skip to content

Commit 8474bab

Browse files
committed
docs: LICENSE README.md
1 parent bbc9914 commit 8474bab

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 Codevor - js-library-boilerplate
3+
Copyright (c) 2019 Codevor - logger.js
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,40 @@
1-
# js-library-boilerplate
1+
# logger
22

33
[![License][license-badge]][license-url] [![Travis CI][travis-badge]][travis-url] [![Coverage Status][coverage-badge]][coverage-url] [![Commitizen][commitizen-badge]][commitizen-url]
44

5-
> js-library-boilerplate-description.
5+
> 💢 Make logging friendlier, simpler and use emojis in your messages. Try logger!
66
77
## Installation
88

9-
js-library-boilerplate is available on npm/yarn:
9+
logger is available on npm/yarn:
1010

1111
```bash
12-
$ npm install js-library-boilerplate --save
13-
$ yarn add js-library-boilerplate
12+
$ npm install logger.js --save
13+
$ yarn add logger.js
1414
```
1515

1616
## Usage
1717

1818
### With ES6/import
1919

2020
```js
21-
import { sum } from 'js-library-boilerplate';
21+
import Logger from 'logger.js';
2222

23-
sum(2, 2); // => 4
23+
Logger.success('Success message example.');
24+
Logger.error('Error message example.');
25+
Logger.warn('Warning message example.');
26+
Logger.info('Information message example.');
2427
```
2528

2629
### With require
2730

2831
```js
29-
const sum = require('js-library-boilerplate').sum;
32+
const Logger = require('logger.js');
3033

31-
sum(2, 2); // => 4
34+
Logger.success('Success message example.');
35+
Logger.error('Error message example.');
36+
Logger.warn('Warning message example.');
37+
Logger.info('Information message example.');
3238
```
3339

3440
## Contributing
@@ -37,21 +43,21 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
3743

3844
## Changelog
3945

40-
This project adheres to [Semantic Versioning](https://semver.org/). Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/codevor/js-library-boilerplate/releases) page.
46+
This project adheres to [Semantic Versioning](https://semver.org/). Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/codevor/logger.js/releases) page.
4147

4248
## Bugs and Sugestions
4349

44-
Report bugs or do suggestions using the [issues](https://github.com/codevor/js-library-boilerplate/issues).
50+
Report bugs or do suggestions using the [issues](https://github.com/codevor/logger.js/issues).
4551

4652
## License
4753

4854
[MIT License](LICENSE) © [Codevor](https://github.com/codevor)
4955

50-
[license-badge]: https://img.shields.io/github/license/codevor/js-library-boilerplate.svg
56+
[license-badge]: https://img.shields.io/github/license/codevor/logger.js.svg
5157
[license-url]: https://opensource.org/licenses/MIT
52-
[coverage-badge]: https://coveralls.io/repos/github/codevor/js-library-boilerplate/badge.svg?branch=master
53-
[coverage-url]: https://coveralls.io/github/codevor/js-library-boilerplate?branch=master
54-
[travis-badge]: https://travis-ci.org/codevor/js-library-boilerplate.svg?branch=master
55-
[travis-url]: https://travis-ci.org/codevor/js-library-boilerplate
58+
[coverage-badge]: https://coveralls.io/repos/github/codevor/logger.js/badge.svg?branch=master
59+
[coverage-url]: https://coveralls.io/github/codevor/logger.js?branch=master
60+
[travis-badge]: https://travis-ci.org/codevor/logger.js.svg?branch=master
61+
[travis-url]: https://travis-ci.org/codevor/logger.js
5662
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
5763
[commitizen-url]: http://commitizen.github.io/cz-cli/

0 commit comments

Comments
 (0)