Skip to content

Commit

Permalink
fixed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
evangelion1204 committed Jan 22, 2014
1 parent 06f112d commit e996eb9
Showing 1 changed file with 1 addition and 61 deletions.
62 changes: 1 addition & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# grunt-real-shell

> Run a shell script synchronously
> A Grunt-Plugin to run a shell script synchronously for our deploy scripts at Zalando Lounge. Thanks to Marcel Alburg for his support.
## Getting Started
This plugin requires Grunt `~0.4.2`
Expand All @@ -22,66 +22,6 @@ grunt.loadNpmTasks('grunt-real-shell');
### Overview
In your project's Gruntfile, add a section named `real_shell` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
real_shell: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
```

### 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({
real_shell: {
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({
real_shell: {
options: {
separator: ': ',
punctuation: ' !!!',
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
});
```

## 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/).

Expand Down

0 comments on commit e996eb9

Please sign in to comment.