Improve README.md

[zachkont]

The README file is underwhelming at the moment. There is room for a lot of improvement, from improving the installation guide to improving the general layout. If anyone has any suggestions, I'm all ears.

[183h]

@zachkont Hi. Can I help? :)

[zachkont]

Sure, you can give it a try but it's not clear to me yet how I want this to be. Open to suggestions though

[yusdacra]

Check the pull request I made. #41

[zachkont]

That's nice but I was thinking of something more detailed, similar to the CONTRIBUTE.md level of analysis

[jmg-duarte]

I took the opportunity to restructure the README.md and took out the "About" from CONTRIBUTE.md since by the time you try to contribute, you should have at least read the README.

My approach was to clean the opinionated parts, add links, correct what the Markdown linter complained about and rewrite some sentences. You can see them here

I know my commit's don't fit your requested style (my bad) but changing them now would be a PITA. I can bundle them together in a new commit if you want though.

If you think the changes OK I'll submit a pull request

[zachkont]

Thanks @jmg-duarte!

The readme looks nice and you were right about removing the about section from contribute. I like how this turned out and it motivates me to complete the installation instructions (that are kind of terrible right now).

Huh, didn't know markdown required asterisks for bullets, I thought dashes were accepted. Thanks for fixing that!

By commits you probably mean your messages. While I do like having things uniform, I don't mind accepting that. It's a minor project after all. However, you can (if you want) use git rebase -i to squash all your commits into one with a proper message.

I will accept the pr either way, go for it and thanks!

[jmg-duarte]

#43 my friend!