Jump to content
Sign in to follow this  

Readme - open the README.md for any npm module

Recommended Posts

The Readme workflow opens the README.md of any npm module within its associated application.  This is generally a Markdown file, so you will want a Markdown viewer.  I use Marked 2.  Here's a list of Markdown-related applications.


This is incredibly handy if you're working with a lot of npm modules; I use it constantly--especially when fussing with a bunch of Grunt tasks.  




For the curious, it works by simply asking npm for the "readme" data of a module, saves it to a temp file, then opens it.  


Known Issues:  

  • No feedback if it can't find the module you're looking for.
  • No autocompletion


Current Version: v1.0


Dependencies:  NodeJS & the internets


Download: Packal / GitHub / Direct



Share this post

Link to post

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Sign in to follow this  
  • Create New...