Website / Development / Issue Tracker / Mailing List
Ever thought perhaps that all the effort that went into creating a good README, while great for your end-users, hadn't ever done you a lick of good when it came to constructing your project's metadata? Well, hang on to your nerd glasses! Here comes a gem that does just that!
Okay, don't get too excited just yet. Though Readme can produce useful results as is, her heuristics are rather limited at this point. With time and contribution she'll be right fine in the not too distant future.
The library is about as easy to use as you can imagine.
require 'readme'
readme = Readme.file
readme.name
readme.description
readme.copyright
It also come with a command line client to pump out the data into variant formats, such a YAML, JSON and even Ruby code.
$ readme --yaml
$ readme description
See the API documentation and readme --help for more information.
Copyright (c) 2009 Rubyworks. All rights reserved.
Readme can be redistributed in accordance with the BSD-2-Clause license.
See COPYING.md file for details.