Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zikani03 committed Apr 20, 2020
1 parent b615a05 commit f661110
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,17 @@ Example: `generateFrom([ (firstName) : { faker -> faker.name().firstName() } ])`

#### Properties

The Groovy script you can modify some variables or properties that affect the
output from zefaker. These variables consequently take precendence over the
ones specified on the command-line. The following variables are available:
Inside the Groovy script you can set some variables or properties that affect the
output of zefaker. These variables, consequently, take precedence over arguments
specified on the command-line.

* *sheetName* - Change the name of the target Sheet in Excel. Overrides `-sheet`
The following special variables are available, and are therefore *reserved names*:

* **sheetName** - Change the name of the target Sheet in Excel. Overrides `-sheet`
* **outputFile** - The name/path of the file to write output to. Overrides `-f`
* *verbose* - Show verbose output. Overrides `-vvv`
* *maxRows* - Sets the maximum number of rows to generate in the file. Overrides `-rows`
* *overwriteExisting* - Whether to overrite an existing file with the new Workbook. Overrides `-x`
* **verbose** - Show verbose output. Overrides `-vvv`
* **maxRows** - Sets the maximum number of rows to generate in the file. Overrides `-rows`
* **overwriteExisting** - Whether to overrite an existing file with the new Workbook. Overrides `-x`

## Building

Expand All @@ -126,7 +128,6 @@ Here are some ideas:
- Decrease the size of the JAR using either Java 9+ modules or Proguard to strip out stuff we don't need
- Build a native binary using [Graal](https://www.graalvm.org/)
- Handle exceptions raised by/in the input script better
- Export to CSV?

## CONTRIBUTING

Expand Down

0 comments on commit f661110

Please sign in to comment.