Browse Source

update documentation for .tendrc files

pull/2/head
Brett Langdon 12 years ago
parent
commit
513356d4f5
1 changed files with 30 additions and 1 deletions
  1. +30
    -1
      README.md

+ 30
- 1
README.md View File

@ -13,8 +13,9 @@ npm install -g tend
## Usage ## Usage
``` ```
Usage: Usage:
tend
tend (--help | --version) tend (--help | --version)
tend [--restart] [--ignoreHidden] <dir> <command> [<filter>]
tend [--restart] [--ignoreHidden] [<dir> <command>] [<filter>]
Options: Options:
-h --help Show this help text -h --help Show this help text
@ -27,6 +28,34 @@ Options:
tend --restart --ignoreHidden ./ "node server.js" 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 ## License
``` ```
The MIT License (MIT) Copyright (c) 2014 Brett Langdon <brett@blangdon.com> (http://brett.is) The MIT License (MIT) Copyright (c) 2014 Brett Langdon <brett@blangdon.com> (http://brett.is)


Loading…
Cancel
Save