I'm not so sure there's One Right Way, but I'll share with you what I personally like: I like to know where the 'HQ' is for that module. By finding out where that module is headquartered, I can probably get the following information directly, (or at least get some good hints):

• Do I have the latest version?
• Any hot bugs not in my version?
• Is there community support? Is it good?
• Any good examples?
• Any recommended 'competitors' or alternatives? <--- this can be a goldmine

So, for me, README is a place not to store the hairy details of a module's installation and use, it's more a place for Meta-Information. A place where I can find out more *about* a module.

---

---

Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!

Titles consisting of a single word are discouraged, and in most cases are disallowed outright.

Read Where should I post X? if you're not absolutely sure you're posting in the right place.

Please read these before you post! —

• How do I compose an effective node title?
• How do I post a question effectively?
• Markup in the Monastery

Posts may use any of the Perl Monks Approved HTML tags:

a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr

You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)

	For:		Use:
	&		&
	<		&lt;
	>		&gt;
	[		&#91;
	]		&#93;

Link using PerlMonks shortcuts! What shortcuts can I use for linking?

See Writeup Formatting Tips and other pages linked from there for more info.