Update and prettify README, add Travis & Coveralls badges #636

Closed
wants to merge 1 commit into
from

Projects

None yet

2 participants

@LucasRMehl
Contributor

I mainly set out to let Github display the reStructuredText and add the Travis-CI/Coveralls badges, but I realized that the README is pretty out of date in general. I tried to update it to the best of my ability, but I'm not familiar enough with Paramiko to say I did it well. I'm willing to work further on this if you'd like.

For the (current) final product, see:

https://github.com/LucasRMehl/paramiko/tree/prettify_readme2#readme

Thanks!

@bitprophet
Member

Thanks! Need to generate a useful diff to see what you actually changed but +1 on the general idea. If you slap one into a gist or such that'll help me get to "mash Merge" faster...:)

@LucasRMehl
Contributor

Thanks for the tip about Gist! Much nicer diff:

https://gist.github.com/LucasRMehl/5cb6879636017b592d40/revisions

@bitprophet
Member

Good stuff! I'll pull it back to 1.13 or so and merge-up, which may or may not play well with Github's merge detector.

@bitprophet bitprophet added a commit that referenced this pull request Dec 11, 2015
@bitprophet bitprophet Changelog re #636 8ca9a1d
@bitprophet bitprophet closed this Dec 11, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment