Improve documentation in README file - Githubissues

metricfu / metric_fu

A fist full of code metrics

http://metricfu.github.com/metric_fu

MIT License

627 stars 96 forks source link

Improve documentation in README file #330

Closed lubc closed 2 years ago

lubc commented 2 years ago

This PR updates the README file with the following changes:

Fixes broken links
Fixes formatting issues
Adds an explanation of what the gem does
Reorganizes sections so it's easier to follow
Improves some sections and merges others
Removes Maintainers section

Please check it out, thanks!