Jump to content

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



Link to comment

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Create New...