README-driven project metadata

README.md

Package Name (1.2.3)

Short package description; useful for quick one-liners when displaying information about it on various sites/contexts.

Normal Readme Stuff

Blah, blah blah. The order of readme sections doesn't matter: organize it however you like.

The parser would be looking for headers w/ specific titles (Dependencies, Development Dependencies, ???), and the first section only.

...

Dependencies

• github.com/foo/bar (1.2.3)
• bitbucket.org/fizz/buzz (3.1.0)

Development Dependencies

• launchpad.net/gocheck (1.0.0)

...and maybe more readme stuff goes here...

Some notes and ideas:

• Any links/images in the first header would be ignored (e.g. badges)
• The order of the Dependencies/Development Dependencies sections shouldn't matter; you can place them anywhere in the readme
• Header level doesn't matter
• For dependencies, the only parsed text is the link title; URL is ignored. In fact, plain text is fine too.

Interesting idea. nut.json is there to stay (it's too late for breaking changes), but probably nut generate may be used to update README according to nut.json content.