Skip to content

Commit

Permalink
Added 1.1.0 changes to README
Browse files Browse the repository at this point in the history
  • Loading branch information
inxilpro committed Dec 4, 2015
1 parent d01a59c commit 605f09a
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,14 @@ Your JSON file should define the environmental variables as keys, and either a b
"description": "This defines the current environment"
},
"PORT": {
"required": false,
"description": "This is the port the API server will run on"
"description": "This is the port the API server will run on",
"default": 3000
},
"NODE_PATH": true,
"DEBUG": false
"DEBUG": {
"required": false,
"description": "If set, enables additional debug messages"
}
}
```

Expand All @@ -63,12 +66,15 @@ Defines whether or not this variable is required. By default, all variables are

Describes the variable and how it should be used. Useful for new developers setting up the project, and is printed in the error output if present.

#### `default`

Defines the default value to use if variable is unset. Implicitly sets `required` to `false`.

## Planed Enhancements

There are two major enhancements in the pipeline:

1. Default values
2. Value validation (type, enum, regex)
1. Value validation (type, enum, regex)

### See Also

Expand All @@ -82,6 +88,10 @@ If you like this module, you may also want to check out:

## Change Log

### 1.1.0
- Added support for default values
- Added support to change filename via `setFilename()`

### 1.0.6
- Bugfix — please do not use versions before 1.0.6

Expand Down

0 comments on commit 605f09a

Please sign in to comment.