DEV Community

Discussion on: My pet project - what do you guys think?

Collapse
bigj1m profile image
Jean-Michel Plourde • Edited on

I haven't jumped into the code yet, but I have an advice to give you on the README.md. The readme is the display window of your project and like a store it aims at selling your idea to potential customers/users.

Don't get me wrong, that's an amazing project packed with interesting features. A huge wall of text about all of them is a bit too much. What is currently in the readme is more suitable for the documentation of your project. You would really benefit from using this template format so you are sure to display everything there is to know about your project so user can quickly jump in to use or contribute to your project. There is also an awesome list of README to get inspired from.

Otherwise it's really impressive that you tackled this kind of project. You'll have a promising career. Happy coding!

Collapse
ethan_ profile image
Ethan Zerad Author

I'm really glad you took the time to write this, I never looked at it that way. I highly appreciate your advice and will surely follow it! Again, thank you.