0.0
No commit activity in last 3 years
No release in over 3 years
Get the README from a GitHub repository
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 4.2.0
 Project Readme

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.