From 98aeb0d44faa8f007884c923f9113c208335d445 Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Sun, 13 Feb 2011 00:14:29 +0100 Subject: [PATCH] Update documentation, node-mmap can now be installed through npm. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 06ece13..f1bb850 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,13 @@ mmap(2) bindings for node.js - stop slurping, start mapping. -## Compiling +## Installing -Easy as pie: +Through [npm](http://npmjs.org/): + + npm install mmap + +Or compile it from source with this one-liner: node-waf configure build install @@ -55,4 +59,4 @@ The file is automatically unmapped when the buffer object is garbage collected. ## Limitations -* Specifying the memory address is not implemented. I couldn't think of a reason why you would want to do that from JavaScript. Convince me otherwise. :-) \ No newline at end of file +* Specifying the memory address is not implemented. I couldn't think of a reason why you would want to do that from JavaScript. Convince me otherwise. :-)