Convert `README.rst` from reStructuredText to GitHub-flavored Markdown

[kattni]

What is the problem or limitation you are having?

The README file for this repository is currently formatted using reStructuredText.

Describe the solution you'd like

The README should be converted to GitHub-flavored Markdown from rST. There are multiple methods to convert rST to Markdown.

Once conversion is complete, verify that the two files are rendering the same. This may require some cleanup, especially around headers and code syntax.

Delete the README.rst file before submitting a PR.

Describe alternatives you've considered

None.

Additional context

One possible conversion option is pandoc. Pandoc installation instructions can be found here.

To use pandoc to convert the README.rst file from rST to GitHub-flavored Markdown, run the following command from the same directory as the README.rst file:

pandoc -s README.rst -t gfm -o README.md

This command may result in an incorrect formatting of the title; the title should be formatted as # Title. Ensure you are verifying that the results you are getting are what you expect.

Then verify the two files are rendering the same.