Skip to content

Commit d8bcdff

Browse files
author
Caleb Whiting
committed
improved documentation
1 parent c2ec792 commit d8bcdff

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# gulp-atomizer
2-
Atomizer needs a gulp plugin! Hopefully this project will fill that need.
2+
3+
Gulp plugin for [Atomizer](https://github.com/yahoo/atomizer).
4+
5+
Warning: This is my first gulp plugin. You may find some rough edges. If something doesn't work right **please submit a bug report or pull request**. I'm committed to maintaining it and making it work like any other first-class gulp plugin.
6+
7+
## Installation
8+
```
9+
npm install --save-dev gulp-atomizer
10+
```
11+
12+
## Example
13+
```
14+
var gulp = require('gulp');
15+
var acss = require('gulp-atomizer');
16+
17+
gulp.task('acss', function() {
18+
return gulp.src('./*.html')
19+
.pipe(acss())
20+
.pipe(gulp.dest('dist'));
21+
});
22+
```
23+
24+
## Testing
25+
Use [Mocha](http://mochajs.org/).
26+
```
27+
npm install -g mocha # install globaly
28+
mocha # run the tests
29+
```

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "gulp-atomizer",
33
"version": "1.0.0",
44
"description": "Gulp plugin for Atomizer",
5+
"tags": "gulpplugin",
56
"main": "index.js",
67
"scripts": {
78
"test": "echo \"Error: no test specified\" && exit 1"

0 commit comments

Comments
 (0)