Skip to content

Commit e46828f

Browse files
committed
Add information on module specific configurations
1 parent b6b3bc6 commit e46828f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ dynamic content on a single server. It extends
88
Installation
99
------------
1010

11-
`npm install -g api`
11+
npm install -g api
1212

1313
Usage
1414
-----
@@ -58,6 +58,11 @@ defines `.conf/module` as the directory for submodules and registers one module
5858

5959
[stoopid]: https://github.com/mikeal/stoopid
6060

61+
Each module may have its own configuration JSON files. These go directly into
62+
the `.conf` directory. Just create a JSON file with the name of the module
63+
(e.g. `.conf/example.json`) and it will be exposed to the `conf` parameter.
64+
65+
Here’s the code of an example module.
6166

6267
`.conf/modules/example.js`:
6368

0 commit comments

Comments
 (0)