abacha/seriestimr — Issue #3: README needs improvement
Author: sandal
Created: 2012-01-29 10:15:12+00:00
State: open

Your README is a bit too minimal to be especially useful.

I think that some background information on how the script works would be nice. It can be as simple as saying it scrapes the wikipedia listings with a link to one as an example.

Additionally, because you only have three flags, it seems like showing the terminal output for each of them would be nice, giving the user a preview of what to expect. You can possibly trucate the "all episodes" listing by inserting a ... line in between the first and last few lines.

A license should be added as well. If you don't have strong preferences, MIT license is maximally permissive and widely accepted in the Ruby community. It can be easily embedded at the bottom of a README file, check out one of MU's libraries [md_preview](https://github.com/mendicant-university/md_preview/tree/) for an example. You may choose any GPLv3 compatible free software license you'd like if there's something else you'd prefer, but generally speaking that boils down to MIT, BSD, GPLv3, or AGPLv3(for web apps) unless you really have pecuiliar tastes :)