{"id":22980989,"url":"https://github.com/rubyworks/readme","last_synced_at":"2025-04-02T09:42:03.726Z","repository":{"id":2423945,"uuid":"3392722","full_name":"rubyworks/readme","owner":"rubyworks","description":"Extract useful information from README files","archived":false,"fork":false,"pushed_at":"2012-02-09T04:02:01.000Z","size":112,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-09T13:36:23.813Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://rubyworks.github.com/readme","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rubyworks.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-02-08T23:58:34.000Z","updated_at":"2016-04-25T14:21:12.000Z","dependencies_parsed_at":"2022-08-21T00:50:31.055Z","dependency_job_id":null,"html_url":"https://github.com/rubyworks/readme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Freadme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Freadme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Freadme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Freadme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyworks","download_url":"https://codeload.github.com/rubyworks/readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246793012,"owners_count":20834921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-15T01:46:32.190Z","updated_at":"2025-04-02T09:42:03.697Z","avatar_url":"https://github.com/rubyworks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# README\n\n[Website](http://rubyworks.github.com/readme) /\n[Development](http://github.com/rubyworks/readme) /\n[Issue Tracker](http://github.com/rubyworks/readme/issues) /\n[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist)\n\n[![Build Status](https://secure.travis-ci.org/rubyworks/readme.png)](http://travis-ci.org/rubyworks/readme)\n\n\n## Description\n\nEver thought perhaps that all the effort that went into creating a good README,\nwhile great for your end-users, hadn't ever done you a lick of good\nwhen it came to constructing your project's metadata? Well, hang on to your\nnerd glasses! Here comes a gem that does just that!\n\nOkay, don't get too excited just yet. Though Readme can produce useful results\nas is, her heuristics are rather limited at this point. With time and **contribution**\nshe'll be right fine in the not too distant future.\n\n\n## Instruction\n\nThe library is about as easy to use as you can imagine.\n\n    require 'readme'\n\n    readme = Readme.file\n\n    readme.name\n    readme.description\n    readme.copyright\n\nIt also come with a command line client to pump out the data into variant\nformats, such a YAML, JSON and even Ruby code.\n\n    $ readme --yaml\n\n    $ readme description\n\nSee the [API documentation](http:/rubydoc.info/gems/readme) and `readme --help` for more information.\n\n\n## Copyright\n\nCopyright (c) 2009 Rubyworks. All rights reserved.\n\nReadme can be redistributed in accordance with the **BSD-2-Clause** license.\n\nSee COPYING.md file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Freadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyworks%2Freadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Freadme/lists"}