From cd81a594187e0f2873f78870d1e12558ea310bce Mon Sep 17 00:00:00 2001 From: Raul Ochoa Date: Mon, 15 Feb 2016 16:53:31 +0100 Subject: [PATCH] Adds some notes about how to npm link windshaft for development --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 88d4b897..6045cda7 100644 --- a/README.md +++ b/README.md @@ -67,3 +67,16 @@ Contributing --- See [CONTRIBUTING.md](CONTRIBUTING.md). + +### Developing with a custom windshaft version + +If you plan or want to use a custom / not released yet version of windshaft (or any other dependency) the best option is +to use `npm link`. You can read more about it at [npm-link: Symlink a package folder](https://docs.npmjs.com/cli/link). + +**Quick start**: + +```shell +~/windshaft-directory $ npm install +~/windshaft-directory $ npm link +~/windshaft-cartodb-directory $ npm link windshaft +```