Skip to content

Commit a43f3e3

Browse files
committed
Update README
1 parent 14a146e commit a43f3e3

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,19 @@ Tool for filling nexrender config templates with CSV data.
1414

1515
## Configuring nerc.yml
1616

17-
An example:
17+
An example of `nerc.yml` file:
1818
```yaml
19-
input: test_data/products.csv
20-
templates: "test_data/templates/"
21-
output: output/
22-
variables:
23-
csvMapping: # CSV to Template variable mapping
24-
ProductName: 6 # CSV column no for product name
25-
ProductPrice: 14 # CSV column no for product price
26-
ProductImage: 21 # CSV column no for product image
27-
staticVariables: # Hard coded template variables
28-
VideoFile: "video.avi"
19+
input: test_data/products.csv # Defines the CSV input filepath
20+
templates: "test_data/templates/" # Defines the dirpath of the template files
21+
output: output/ # Defines the output dirpath
22+
variables: # Defines template variables
23+
- key: ProductName # Defines the variable key or "name"
24+
csvSourceCol: 6 # CSV column no for product name
25+
- key: ProductPrice
26+
csvSourceCol: 14
27+
type: price # Type of the variable. Price is rendered with two decimals.
28+
- key: ProductImage
29+
csvSourceCol: 21
30+
- key: VideoFile
31+
value: "video.avi" # Hard coded value to be used
2932
```

0 commit comments

Comments
 (0)