Skip to content

Commit aef0b20

Browse files
committed
Actually tell the reader the name of the config file. Closes #6
1 parent 9919c67 commit aef0b20

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ typical low-level configuration nightmares.**
2727
$ npm install faucet-pipeline-js faucet-pipeline-sass
2828
```
2929
30-
* configure ([learn more about this file](#config-file)):
30+
* configure with `faucet.config.js` ([learn more about this file](#config-file)):
3131
3232
```javascript
3333
let js = {
@@ -134,8 +134,8 @@ If you've written another adapter, please open a PR to add it to the list.
134134
## CLI
135135

136136
If you call the `faucet` command without any arguments, it will default to
137-
building your project according to the configuration in the file `faucet.js` in
138-
the current directory. You have the following options:
137+
building your project according to the configuration in the file
138+
`faucet.config.js` in the current directory. You have the following options:
139139

140140
* `-c $FILENAME` or `--config=$FILENAME`: Use the file `$FILENAME` as the
141141
configuration file.
@@ -153,11 +153,11 @@ reduces clutter on your disk) and `--compact` for production.
153153

154154
## Config File
155155

156-
The config file for faucet is a JavaScript file. In this file, you should export
157-
an object that contains the configuration. For each pipeline you want to use,
158-
you need to export an object with the according configuration. In addition, you
159-
can do some general configuration of the file watcher. So it might look
160-
something like this:
156+
The config file (default: `faucet.config.js`) for faucet is a JavaScript file.
157+
In this file, you should export an object that contains the configuration. For
158+
each pipeline you want to use, you need to export an object with the according
159+
configuration. In addition, you can do some general configuration of the file
160+
watcher. So it might look something like this:
161161

162162
```js
163163
module.exports = {

0 commit comments

Comments
 (0)