Skip to content

Commit 5bb0dc7

Browse files
committed
Updated API documentation to explain overloaded API, bump version to 0.1.2
1 parent 21e149c commit 5bb0dc7

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,12 @@ gulp.task('css', function() {
2121
});
2222
```
2323

24-
## Options
24+
## API
2525

26-
### Rule configuration
26+
### csslint(ruleConfiguration)
27+
28+
#### ruleConfiguration
29+
Type: `Object`
2730

2831
You can pass rule configuration as an object. See the [list of rules by ID on the CSSLint wiki](https://github.com/stubbornella/csslint/wiki/Rules-by-ID) for valid rule IDs.
2932

@@ -35,9 +38,12 @@ gulp.src('./client/css/*.css')
3538
.pipe(csslint.reporter());
3639
```
3740

38-
### CSSLint RC
41+
### csslint(csslintrc)
42+
43+
#### csslintrc
44+
Type: `String`
3945

40-
You can also pass the path to your csslintrc file:
46+
You can also pass the path to your csslintrc file instead of a rule configuration object.
4147

4248
```javascript
4349
gulp.src('./client/css/*.css')

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "gulp-csslint",
3-
"version": "0.1.1",
3+
"version": "0.1.2",
44
"description": "CSSLint plugin for gulp",
55
"main": "index.js",
66
"dependencies": {

0 commit comments

Comments
 (0)