Documentation improvements

xrmx / uwsgitop

top-like app for monitoring uWSGI instances

MIT License

496 stars 77 forks source link

Documentation improvements #34

Closed iiSeymour closed 9 years ago

iiSeymour commented 9 years ago

A few documentation improvements:

~~incremented the copyright year.~~ [moved to separate PR]
removed the duplicated README file.
added some more information to README.md.
marked up the README.md with markdown.

The rendered version of the README.md can be seen here.

iiSeymour commented 9 years ago

I will clean up the history and look into markdown vs restructured text for pypi.

iiSeymour commented 9 years ago

@xrmx what are your thoughts on this https://coderwall.com/p/qawuyq/use-markdown-readme-s-in-python-modules?

xrmx commented 9 years ago

@iiSeymour i think it is overkill, rst is very similar to md so not much changes are needed. I can do the conversion myself so just update the pull request with the two README related commits and i'll take care of it.

iiSeymour commented 9 years ago

@xrmx you are right. Seeing as github supports both markdown and rst but pypi only supports rst the best thing to do is use rst. I accidentally rebased a few too many commits to I'll submit a new clean PR.