diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..39dfb1a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# 1.1.0 + +- Replaced cosmiconfig with rcload to minimize bundle size. + +# 1.0.0 + +- Initial version diff --git a/README.md b/README.md index 2a5cc19..2f1c00c 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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.: