Skip to content

Commit 2f9300f

Browse files
committed
docs(readme.md): update usage and links to lib
Update the Usage section and links to where to download with npm and yarn. Add a section for describe the `setEmoji` method
1 parent 9acc3dd commit 2f9300f

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,56 @@
99
logger is available on npm/yarn:
1010

1111
```bash
12-
$ npm install logger.js --save
13-
$ yarn add logger.js
12+
$ npm install @codevor/logger.js --save
13+
$ yarn add @codevor/logger.js
1414
```
1515

1616
## Usage
1717

1818
### With ES6/import
1919

2020
```js
21-
import Logger from 'logger.js';
21+
import Logger from '@codevor/logger.js';
2222

2323
Logger.success('Success message example.');
24+
// => ✅ Success message example
2425
Logger.error('Error message example.');
26+
// => 🚫 Error message example
2527
Logger.warn('Warning message example.');
28+
// => ⚠️ Warning message example
2629
Logger.info('Information message example.');
30+
// => ℹ️ Informational message example
2731
```
2832

2933
### With require
3034

3135
```js
32-
const Logger = require('logger.js');
36+
const Logger = require('@codevor/logger.js');
3337

3438
Logger.success('Success message example.');
39+
// => ✅ Success message example
3540
Logger.error('Error message example.');
41+
// => 🚫 Error message example
3642
Logger.warn('Warning message example.');
43+
// => ⚠️ Warning message example
3744
Logger.info('Information message example.');
45+
// => ℹ️ Informational message example
46+
```
47+
48+
### Change Emojis
49+
50+
Is it possible to change emojis for each message? **Yes**! Check it out:
51+
52+
```js
53+
import Logger from '@codevor/logger.js';
54+
55+
Logger.success('Success message example.');
56+
// => ✅ Success message example
57+
58+
Logger.setEmoji({ type: 'success', emoji: '🐶' });
59+
60+
Logger.success('Success message example.');
61+
// => 🐶 Success message example
3862
```
3963

4064
## Contributing

0 commit comments

Comments
 (0)