https://github.com/dkhamsing/github-readme
:octocat: Get the README from a GitHub repo
https://github.com/dkhamsing/github-readme
Last synced: 7 months ago
JSON representation
:octocat: Get the README from a GitHub repo
- Host: GitHub
- URL: https://github.com/dkhamsing/github-readme
- Owner: dkhamsing
- License: mit
- Created: 2016-02-19T18:57:00.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-09T20:27:52.000Z (about 10 years ago)
- Last Synced: 2025-03-29T15:35:04.938Z (about 1 year ago)
- Language: Ruby
- Homepage:
- Size: 5.86 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# github-readme
Get the README from a GitHub repository :octocat:
[](https://badge.fury.io/rb/github-readme) [](https://travis-ci.org/dkhamsing/github-readme)
## Installation
```shell
$ gem install github-readme --pre
```
## Usage
### Command Line
```shell
$ github-readme dkhamsing/awesome_bot
Gettin README for dkhamsing/awesome_bot ...
Writing dkhamsing-awesome_bot-readme.md
```
### Library
```shell
$ irb
irb(main):001:0> require 'github-readme'
=> true
irb(main):002:0> GitHubReadme::get 'postmates/PMJSON'
=> {=> {"name"=>"README.md", "readme"=>"# PMJSON\n\n[![Version](https://...", "summary"=>"PMJSON provides a pure-Swift strongly-typed JSON encoder/decoder as well as a set of convenience methods for converting to/from Foundation objects and for decoding JSON structures.", "error"=>nil}
```
## Contact
- [github.com/dkhamsing](https://github.com/dkhamsing)
- [twitter.com/dkhamsing](https://twitter.com/dkhamsing)
## License
This project is available under the MIT license. See the [LICENSE](LICENSE) file for more info.