Project

readem

0.0
No commit activity in last 3 years
No release in over 3 years
Serve the READMEs in your ~/Projects in a web browser
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0

Runtime

~> 2.3
~> 1.4
 Project Readme

An amazing tool renders readmes in realtime

Assuming I have all my projects in the ~/Projects directory, we can start a web server on port 1337 which renders a list of projects which have a README.

When I want to serve up all my readmes, I enter this at the terminal:

gem install readem
readem

Then my browser will automagically open the URL http://localhost:1337/ and view a list of links to projects.

When I click one of the links, the readme for that repository is displayed.

Not yet true

Then it reloads the readme every 3 seconds after I stop editing, so I can view my changes in "realtime".