In readme how to use section, import statement is importing the library from index.js, but this is an npm library so the import should be like this

var log = require('ak-logger');

The usage example in readme (How to use) seems to be wrong.

That needs to be fixed to make it correct.

At present debug in log statement is defined as a variable and that will through an error while using in real code

Add "Contributors" title right above the contributors images.

In README.md file, the link to Contributors guide is broken.

Fix the link to redirect to this url
https://github.com/arshadkazmi42/ak-logger/blob/master/CONTRIBUTING.md

Add below values as 9th step in CONTRIBUTING.md

(Optional) Give star to the repo if you like the project.

If you are starting with opensource contributions, this is best to start with.
just go ahead and add your details to Contributors.md file in the same format as other's details.

@vvscode @markost2549
Since you guys have already contributed for us, why don't your name to Contributors.md and create a PR

Contributing file does not contain any information regarding tests. We would like to include some testing related stuffs in the file,

Change it to something like this
https://github.com/arshadkazmi42/custom-date-formatting/blob/master/CONTRIBUTING.md

Remove the NOTE block from README.md

• Few badges are broken in readme.
• How to install image is broken

Let's fix all these issues

• Delete package-lock.json
• Run npm install
• Commit package-lock.json
• Create pull request

Describe the bug
Current test script only automatically logs in the console and needs to be verified manually. We need to improve the test script to cover more scenarios and remove manual interventions

This library supports two types of logging

1. String logging
2. JSON logging

So for logging a json, it needs to be stringified, and the log function takes json boolean flag as third parameter to the function.

But we do not have this example in the readme file. This needs to be added.

Add gitignore file and to ignore ide configs & node_modules

Describe the bug
Currently all the test dependencies are added in dependencies object in package.json

Expected behavior
All the test related dependencies should reside in dev-dependencies object of package.json

Additional context
To fix this, chai & mocha these two dependencies are for testing purpose, so these should be moved to dev-dependencies of package.json

There is a detailed explanation of package.json file here
https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies

Describe the bug
Add code quality badge to readme

Additional context
Add Code Quality badge next to downloads badge in README file

just copy the below code and add it in readme below downloads code

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/66e512e5be9845999fed9586e25ff346)](https://www.codacy.com/app/arshadkazmi42/ak-logger?utm_source=github.com&utm_medium=referral&utm_content=arshadkazmi42/ak-logger&utm_campaign=Badge_Grade)

To work on this

1. Put a comment here who ever is working on it.
2. Also tag this issue in your Pull Request description.

Note: Anyone who is not following above two steps, their PR will be rejected

Hi there,

Thank you for your interest in Hacktoberfest and in helping others make their first contributions to open source.

While we agree that it's important to help others, this repository does not do this in a way that is in line with the Hacktoberfest values. Please read the part that talks about high-quality contributions to understand why we are reaching out and taking action. Due to this, we've added this repository to the list of excluded repositories which means pull requests here will not count toward Hacktoberfest 2020.

This is not a DigitalOcean decision, it's one that is inspired by the community of maintainers and contributors who all agree that quality is more important than quantity when it comes to engagement in the Open Source community. The values remind us to shift the focus from contributions to repositories that encourage folks to quickly create and gain a pull request to contributions that will help people level-up their skills and contribute to open-source projects that are in need of help.

If you feel that this repository is an effective learning resource, we encourage you to keep running it since a core part of the aim for Hacktoberfest is to encourage new folks to get involved with open-source.

However, if you are interested in having contributions to this repo count toward Hacktoberfest we encourage you to take a look at this list of Hacktoberfest issues for inspiration and make the necessary changes to focus on enabling people to make meaningful contributions to open source projects.

If you have any questions about this or participating in Hacktoberfest, please contact our team via email [email protected] or join our community Discord server.

Happy Hacking,
The Hacktoberfest Team

Hacktoberfest is presented by DigitalOcean, Intel and DEV.

Add a file name PULL_REQUEST_TEMPLATE.md in .github directory.
With the below content in the file

Fixes #