Help me improve my open source project Readme

I want to make the Readme as user friendly as possible, so I’d love to hear your thoughts on this. Any thoughts and ideas are welcome :+1:.

You’ll find the project Readme here :spiral_notepad:.

Thank you in advance!
/ David

Looks like all the info a README should have: A demo link, how to install it, how to use it, how to configure it, and how to program it. even mentions the license. I can’t think of anything else you’d need to add to it. Nicely done.

1 Like

@chuckadams, thank you for your kind words :relaxed:.

I want to list some features that comes with the package out of the box. Do you have any ideas of how to present that on the Readme page :bulb:?

I’d stick a bulleted list of features right up in the top section, keeping it to major features so they don’t get overloaded and tl;dr, since they can always read through the API section and see the rest of the features that way.

1 Like

@chuckadams, thanks for the feedback. Really helpful :slightly_smiling_face:!