Layout of README.md

Open theycallmemac opened this issue 6 years ago • 1 comments

This is a great project, has really helped me out. Some discussion needs to me had about the format of the README.md though. Readability and organization is important.

If you're encouraging folks to use Docker, I feel like that would come nearer the beginning of the document. Also do you think it's looking into providing more Docker images too perhaps?

Along with this, having the 250m, 90m, and 30m all on the same document leads to clutter, it may be better if each was separated into it's own markdown file, with each file being linked to this README.md

Just ideas would love to hear your thoughts!

Dec 02 '19 21:12 theycallmemac

Hey :)

Thank you for your suggestions. I think this README.md is definitely better readable than the original one ;) but I can be improved

I have no experience in using Docker, that's why I put it at the end of the file. I also want to keep the documentation about using 250m, 90m and 30m in the same file, because you have a quick overview about the different options and can compare them easily. The Readme.md is not that long that is why I keep the Readme.md in one file.

I am open for your thoughts or suggestions and maybe you can make a PullRequest with your idea. I will have a look and maybe you have a good idea.

See you Developer66

Dec 10 '19 16:12 Developer66