Readme_cli is a command-line tool that instantly fetches and diplays Readme files of github repositories in the command line interface
Requires Python 3.0> and Pip installed.
$ pip install read-me-cli==0.2.1
Run readme_cli with the url to the github repository:
$ readme_cli [github repository url]
This will fetch the readme.md contents of that repository and display them in the CLI.
In the terminal, you type the command:
$ readme_cli https://github.com/vinta/awesome-python
The results:
Note: Scrolling up and down is done by the Up and Down Keyboard buttons.
To make a contribution, fork the repo, make your changes and then submit a pull request. Please try to adhere to the existing style. If you've discovered a bug or have a feature request, create an issue!
Readme_cli is written in Python and built on Urwid. Beautiful Soup is used to scrape Github content.
Special thanks to awesome-cli-apps, awesome-shell, terminals-are-sexy, and awesome-mac for the inspiration!