Update README for Improved Documentation

open-xyz / xmail

Simple, modern, lightweight & fast web-based email client.

Apache License 2.0

7 stars 20 forks source link

Update README for Improved Documentation #20

Closed jinx-vi-0 closed 4 months ago

jinx-vi-0 commented 4 months ago

The current README is not visually appealing and also lacks some sections like how to make pr, contributors, etc. I would also like to update readme and also properly format the documentation.

rohansx commented 4 months ago

@jinx-vi-0 I don't think it's a good idea to add 'how to make a PR' in the README file, since the contributing.md file is specifically for that purpose. What other improvements can you suggest for the README file?

jinx-vi-0 commented 4 months ago

@rohansx ok so I can improve its formatting like add badges for tech stacks, repo stats counts and include contributors at the bottom of readme.

sesiii commented 4 months ago

Can someone explain what is the project about? What do we need to build?