[Bug] Updating Readme document

Bhanu-code / db-drawer

database schema visualization cli tool on localhost for node.js environment

https://www.npmjs.com/package/db-drawer

MIT License

9 stars 18 forks source link

[Bug] Updating Readme document #43

Closed SuhainaFathimaM closed 6 months ago

SuhainaFathimaM commented 6 months ago

Is there an existing issue for this?

[X] I have searched the existing issues

Current Behaviour

No response

Expected Behaviour

No response

Steps to Reproduce

No response

Environment

- OS:
- Node:
- npm:

Anything else?

No response

On what browsers you're seeing the problem.

No response

SuhainaFathimaM commented 6 months ago

@Bhanu-code I would like to work this task.. Please assign me this task under GSSoC'24 label..

Bhanu-code commented 6 months ago

@SuhainaFathimaM what update you want to do in README?

aasthakourav20 commented 6 months ago

@SuhainaFathimaM what update you want to do in README?

Hey @Bhanu-code l , A Readme file plays an important role in User/Contributor convenience .It provides an overview of the project's purpose, how to install and use it, and any necessary prerequisites. Additionally, the README often includes guidelines for contributing, links to documentation, and contact information for the maintainers. Let's create a more descriptive , attention seeking README file including all guidelines .

Kindly assign this issue to me under GSSoC'24 .

Bhanu-code commented 6 months ago

@aasthakourav20 I think, we have all the things included in REAME.md, Learn.md, CODE_OF_CONDUCT, etc. Please go through README.md, Learn.md

aasthakourav20 commented 6 months ago

@aasthakourav20 I think, we have all the things included in REAME.md, Learn.md, CODE_OF_CONDUCT, etc. Please go through README.md, Learn.md

Hey @Bhanu-code , the current readme looks quite undescriptive , unstructured . We can make it well descriptive well structured , can add more features about the project and User/Contributors friendly guidelines .