Skip to content

Commit 40b1927

Browse files
committed
Docs: Add stubbed readme
1 parent 952a521 commit 40b1927

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<p align="center">
2+
<a href="http://gulpjs.com">
3+
<img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
4+
</a>
5+
</p>
6+
7+
# vinyl-sourcemap
8+
9+
[![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] [![Gitter chat][gitter-image]][gitter-url]
10+
11+
Add/write sourcemaps to/from Vinyl files.
12+
13+
## Usage
14+
15+
```js
16+
sourcemap.add(file, function(err, updatedFile) {
17+
18+
});
19+
20+
sourcemap.write(file, './maps', function(err, updatedFile, sourcemapFile) {
21+
22+
});
23+
```
24+
25+
## API
26+
27+
### `sourcemap.add(file, callback)`
28+
29+
### `sourcemap.write(file, [outputPath,] callback)`
30+
31+
## License
32+
33+
MIT
34+
35+
[downloads-image]: http://img.shields.io/npm/dm/vinyl-sourcemap.svg
36+
[npm-url]: https://npmjs.com/package/vinyl-sourcemap
37+
[npm-image]: http://img.shields.io/npm/v/vinyl-sourcemap.svg
38+
39+
[travis-url]: https://travis-ci.org/gulpjs/vinyl-sourcemap
40+
[travis-image]: http://img.shields.io/travis/gulpjs/vinyl-sourcemap.svg?label=travis-ci
41+
42+
[appveyor-url]: https://ci.appveyor.com/project/gulpjs/vinyl-sourcemap
43+
[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/vinyl-sourcemap.svg?label=appveyor
44+
45+
[coveralls-url]: https://coveralls.io/r/gulpjs/vinyl-sourcemap
46+
[coveralls-image]: http://img.shields.io/coveralls/gulpjs/vinyl-sourcemap/master.svg
47+
48+
[gitter-url]: https://gitter.im/gulpjs/gulp
49+
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "vinyl-sourcemap",
33
"version": "0.3.0",
4-
"description": "Add sourcemaps to Vinyl files.",
4+
"description": "Add/write sourcemaps to/from Vinyl files.",
55
"author": "Gulp Team <team@gulpjs.com> (http://gulpjs.com/)",
66
"contributors": [
77
"Robin Venneman",

0 commit comments

Comments
 (0)