Skip to content

Commit fc627cc

Browse files
committed
Docs: Add a proper README
1 parent ab0dff5 commit fc627cc

1 file changed

Lines changed: 39 additions & 1 deletion

File tree

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
1-
# identity-map
1+
# @gulp-sourcemaps/identity-map
2+
3+
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url]
4+
25
Gulp plugin for generating an identity sourcemap for a file.
6+
7+
## Example
8+
9+
```js
10+
var identityMap = require('@gulp-sourcemaps/identity-map');
11+
12+
gulp.src(...)
13+
.pipe(sourcemaps.init())
14+
.pipe(identityMap()) // .js and .css files will get a generated sourcemap
15+
.pipe(sourcemaps.write())
16+
.pipe(gulp.dest(...))
17+
```
18+
19+
## API
20+
21+
### `identityMap()`
22+
23+
Returns an `objectMode` Transform stream that processes each file with a `.sourceMap` property and buffered contents. A sourcemap is generated and attached for each `.js` and `.css` file.
24+
25+
## License
26+
27+
MIT
28+
29+
[downloads-image]: http://img.shields.io/npm/dm/@gulp-sourcemaps/identity-map.svg
30+
[npm-url]: https://npmjs.org/package/@gulp-sourcemaps/identity-map
31+
[npm-image]: http://img.shields.io/npm/v/@gulp-sourcemaps/identity-map.svg
32+
33+
[travis-url]: https://travis-ci.org/gulp-sourcemaps/identity-map
34+
[travis-image]: http://img.shields.io/travis/gulp-sourcemaps/identity-map.svg?label=travis-ci
35+
36+
[appveyor-url]: https://ci.appveyor.com/project/phated/identity-map
37+
[appveyor-image]: https://img.shields.io/appveyor/ci/phated/identity-map.svg?label=appveyor
38+
39+
[coveralls-url]: https://coveralls.io/r/gulp-sourcemaps/identity-map
40+
[coveralls-image]: http://img.shields.io/coveralls/gulp-sourcemaps/identity-map.svg

0 commit comments

Comments
 (0)