Skip to content

:octocat: Get the README from a GitHub repo

License

Notifications You must be signed in to change notification settings

dkhamsing/github-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

github-readme

Get the README from a GitHub repository :octocat:

Gem Version Build Status

Installation

$ gem install github-readme --pre

Usage

Command Line

$ github-readme dkhamsing/awesome_bot
Gettin README for dkhamsing/awesome_bot ...
Writing dkhamsing-awesome_bot-readme.md

Library

$ 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

License

This project is available under the MIT license. See the LICENSE file for more info.

About

:octocat: Get the README from a GitHub repo

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages