Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
baelter committed Nov 18, 2013
1 parent 4321292 commit faf050e
Showing 1 changed file with 21 additions and 45 deletions.
66 changes: 21 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,53 +37,29 @@ grunt.initConfig({

### Options

#### options.separator
Type: `String`
Default value: `', '`

A string value that is used to do something with whatever.

#### options.punctuation
Type: `String`
Default value: `'.'`

A string value that is used to do something else with whatever else.

### Usage Examples

#### Default Options
In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`

```js
grunt.initConfig({
rsimulatorjs: {
options: {},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
})
```

#### Custom Options
In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`

```js
grunt.initConfig({
rsimulatorjs: {
options: {
separator: ': ',
punctuation: ' !!!',
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
})
```
#### options.simulator
Type: `Object`
Default value:
`simulator: {
port: 9005,
rootPath: './mocked-rest-api',
useRootRelativePath: true
}`

#### options.proxy
Type: `Object`
Default value:
`proxy: {
port : 9004,
pathnameOnly : true,
router : {
'/service' : '127.0.0.1:' + 9005,
'' : '127.0.0.1:' + 9001
}
}`

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_
_(Nothing yet)_

0 comments on commit faf050e

Please sign in to comment.