/preview-readme

Preview GitHub rendered readmes locally.

Primary LanguageJavaScript

readme-preview

Preview your README file as it will appear on npmjs.com, before publishing.

Installation

$ npm install tomprogers/preview-readme

Usage

cd ~/code/my-repo
preview-readme

See your file, rendered at http://localhost:5000

Renders the first of these files that it finds in the current directory:

  1. README
  2. README.md
  3. Readme.md
  4. README.markdown

API keys

If you need more than 60 renders per hour, you can get 5000 per hour by going to GitHub Applications Settings and create a new Personal Access Token. Then, put this in your .bash_profile so that preview-readme can use it:

# ~/.bash_profile
README_PREVIEW_API_KEY=yourapitoken

You can also send it as an argument: preview-readme <token>.