Improved edits to the README.md file

[cr2007]

Reference Issue

None

What does this implement/fix? Explain your changes.

This implementation improves the overall layout of the README file

• Improves the Heading
• Adds a link to the logo
• Center-Aligns both the logo and heading
• Improves the Index with sub-bullets as well for the user to go directly to the point they need.
• Adds a Back to Top ↥ button (aligned to the right) to go back to the top when the user is at the bottom of the file

Any other comments?

Feel free to add any more changes to these commits as you please.

Regards,
@cr2007

[bmcfee]

Thanks for this! Would you mind rolling back the alignment bits that use inlined HTML? I'd prefer to keep things strict markdown here as noted in #1473. The README pulls double-duty here as our splash page on the github repository, and the package description in pypi.

[cr2007]

Hey @bmcfee !

Sure, that can be possible
Although as you have written in #1473 , how does it render when it appears in the package description? in pypi?

As center-aligning the logo, header make it easier for them to read
and putting the Back To Top button aligned to the right make it much easier to catch the user's attention amidst the long text.

If you could maybe share a screenshot within this thread of how it looks like, it'd help get a better idea perhaps.

If it doesn't go well, I can change those HTML elements to a (similar) Markdown state.

Regards,
@cr2007

[lostanlen]

Please disregard my review. I hadn't considered the importance of handling PyPI README

[bmcfee]

Although as you have written in #1473 , how does it render when it appears in the package description? in pypi?

The short answer is that I don't know, and I'd prefer to not deploy a test package just to find out.

According to the official docs, github-flavored markdown is supported as the default markdown. While that does techinically allow for inlined HTML, I'd still prefer to avoid it.

[cr2007]

Hi @bmcfee ,

I have done the necessary changes as you had asked in the next commit following your comment.

Let me know if there is anything else that is required.

Regards,
@cr2007

P.S. I do suggest having a look if inline HTML does work in the documentation as it can definitely widen the possibilities of how you can show your documentation out there

[bmcfee]

This looks fine to me. Thanks again.