Permalink
Browse files

[chenjia] - update reade me

  • Loading branch information...
1 parent 3b81ffb commit c3fad79d82821b52065cbeffb834925c398b0d2f @ariesjia committed Jan 26, 2015
Showing with 7 additions and 59 deletions.
  1. +1 −0 .gitignore
  2. +6 −59 README.md
View
@@ -1,4 +1,5 @@
.idea/
node_modules
.DS_Store
+npm-debug.log
View
@@ -17,76 +17,23 @@ Once the plugin has been installed, it may be enabled inside your Gruntfile with
grunt.loadNpmTasks('grunt-riot');
```
-## The "riot" task
-
-### Overview
-In your project's Gruntfile, add a section named `riot` to the data object passed into `grunt.initConfig()`.
-
-```js
-grunt.initConfig({
- riot: {
- 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({
riot: {
- options: {},
- files: {
- 'dest/default_options': ['src/testing', 'src/123'],
- },
+ expand: true,
+ cwd: '<%= app %>/scripts',
+ src: '**/*.tag',
+ dest: '<%= app %>/scripts',
+ ext: '.js'
},
})
```
-#### 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({
- riot: {
- 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/).
-
## Release History
-_(Nothing yet)_
+2015-01-26 0.0.1
## License
Copyright (c) 2015 . Licensed under the MIT license.

0 comments on commit c3fad79

Please sign in to comment.