From 513356d4f52ab860320649a2298d4e6fd48b5b3e Mon Sep 17 00:00:00 2001 From: brettlangdon Date: Tue, 27 May 2014 20:30:10 -0400 Subject: [PATCH] update documentation for .tendrc files --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64921e7..8d5d82a 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,9 @@ npm install -g tend ## Usage ``` Usage: + tend tend (--help | --version) - tend [--restart] [--ignoreHidden] [] + tend [--restart] [--ignoreHidden] [ ] [] Options: -h --help Show this help text @@ -27,6 +28,34 @@ Options: tend --restart --ignoreHidden ./ "node server.js" ``` +### .tendrc + +`tend` can accept it's configuration from a `.tendrc` file rather than taking arguments from +the command line. Using `.tendrc` also allows you to run multiple instances of `tend` at once. + +`.tendrc` files are parsed using [rc](https://github.com/dominictarr/rc). + +```ini +; global settings +ignoreHidden=true + +[js] +directory=./src +command=uglifyjs -o ./build/main.min.js ./src/*.js + +[app] +directory=./app +command=node ./app/server.js +restart=true +``` + +The above config will run two instances of `tend`: +```bash +tend --ignoreHidden ./src "uglifyjs -o ./build/main.min.js ./src/*.js" +# AND +tend --ignoreHidden --restart ./app "node ./app/server.js" +``` + ## License ``` The MIT License (MIT) Copyright (c) 2014 Brett Langdon (http://brett.is)