/node_modules/node-dev/README.md

https://github.com/antonlitvinenko/tracker · Markdown · 35 lines · 20 code · 15 blank · 0 comment · 0 complexity · a73987559a45e47b2791fad91dfc5fff MD5 · raw file 

    

  1. About
    2. 

  2. =====
    3. 

  3. 

  4. Node-dev is a supervisor for Node.js that automatically restarts the node process when a script is modified. Status and error messages are displayed as desktop notification using either [Growl](http://growl.info/about.php) or [libnotify](http://developer.gnome.org/libnotify/).
    5. 

  5. 

  6. Node-dev hooks into the `require()` function to determine which files need to be monitored. Hence it also works with linked modules that live outside of your project directory and doesn't cause any unnecessary server restarts when client-side JavaScript files are modified. 
    7. 

    8. 

  8. 

  9. ![Screenshot](http://fgnass.github.com/images/node-dev.png)
    10. 

  10. 

  11. ![Screenshot](http://fgnass.github.com/images/node-dev-linux.png)
    12. 

  12. 

  13. Usage
    14. 

  14. =====
    15. 

  15. 

  16. Simply use the `node-dev` binary as you would normally use `node`.
    17. 

  17. 

  18. Installation
    19. 

  19. ============
    20. 

  20. 

  21. The node-dev supervisor can be installed via [npm](http://github.com/isaacs/npm):
    22. 

  22. 

  23.     npm install node-dev
    24. 

  24. 

  25. This will add the `node-dev` executable to your PATH.
    26. 

  26. 

  27. In order to use Growl notifications [growlnotify](http://growl.info/extras.php#growlnotify) (form the Extras folder on the Growl disk image) must be installed on your system.
    28. 

  28. 

  29. 

  30. Contributors
    31. 

  31. ============
    32. 

  32. 

  33. * [Ricardo Tomasi](https://github.com/ricardobeat) (CoffeeScript support)
    34. 

  34. * [Sergey Ovechkin](https://github.com/pomeo) (libnotify support)
    35. 

  35. * [Piotr Sokólski](https://github.com/pyetras) (stdin pumping)
    36.