https://github.com/rubyworks/readme
Extract useful information from README files
https://github.com/rubyworks/readme
Last synced: 11 months ago
JSON representation
Extract useful information from README files
- Host: GitHub
- URL: https://github.com/rubyworks/readme
- Owner: rubyworks
- Created: 2012-02-08T23:58:34.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2012-02-09T04:02:01.000Z (about 14 years ago)
- Last Synced: 2025-03-09T13:36:23.813Z (11 months ago)
- Language: Ruby
- Homepage: http://rubyworks.github.com/readme
- Size: 109 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
Awesome Lists containing this project
README
# README
[Website](http://rubyworks.github.com/readme) /
[Development](http://github.com/rubyworks/readme) /
[Issue Tracker](http://github.com/rubyworks/readme/issues) /
[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist)
[](http://travis-ci.org/rubyworks/readme)
## Description
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.
## Instruction
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](http:/rubydoc.info/gems/readme) and `readme --help` for more information.
## Copyright
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.