Skip to content

Commit

Permalink
Update readme and add changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
cenobitedk committed Jan 14, 2020
1 parent 1dcb1c8 commit 1c74f85
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 1.1.0

- Replaced cosmiconfig with rcload to minimize bundle size.

# 1.0.0

- Initial version
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Express middleware to mock requests with JSON and JS files.
## Features

- File based mocks using JSON and JS files.
- Flexible configuration with [cosmiconfig](https://www.npmjs.com/package/cosmiconfig).
- Flexible configuration with [rcload](https://www.npmjs.com/package/rcload).
- Supports preflight requests using [cors](https://www.npmjs.com/package/cors).
- Uses express style path matching with [path-to-regexp](https://www.npmjs.com/package/path-to-regexp).

Expand All @@ -31,12 +31,11 @@ app.use(ermock());

## Setup

It uses [cosmiconfig](https://www.npmjs.com/package/cosmiconfig) and thus supports any of the following:
It uses [rcload](https://www.npmjs.com/package/rcload) and thus supports the following:

- `ermock` property in `package.json`
- `.ermockrc` file in JSON or YAML format
- `.ermockrc.json` file
- `.ermockrc.yaml`, `.ermockrc.yml`, or `.ermockrc.js` file
- `.ermockrc` file in JSON format
- `.ermockrc.json` or `.ermockrc.js` file
- `ermock.config.js` file exporting a JS object

Furthemore it also accepts a configuration object when setting up in express, eg.:
Expand Down

0 comments on commit 1c74f85

Please sign in to comment.