From 40b1927c2319e8d878f6eb2ae4904aa3d2e1abce Mon Sep 17 00:00:00 2001 From: Blaine Bublitz Date: Fri, 21 Apr 2017 15:48:08 -0500 Subject: [PATCH] Docs: Add stubbed readme --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 2 +- 2 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cbe42c4 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +

+ + + +

+ +# vinyl-sourcemap + +[![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] + +Add/write sourcemaps to/from Vinyl files. + +## Usage + +```js +sourcemap.add(file, function(err, updatedFile) { + +}); + +sourcemap.write(file, './maps', function(err, updatedFile, sourcemapFile) { + +}); +``` + +## API + +### `sourcemap.add(file, callback)` + +### `sourcemap.write(file, [outputPath,] callback)` + +## License + +MIT + +[downloads-image]: http://img.shields.io/npm/dm/vinyl-sourcemap.svg +[npm-url]: https://npmjs.com/package/vinyl-sourcemap +[npm-image]: http://img.shields.io/npm/v/vinyl-sourcemap.svg + +[travis-url]: https://travis-ci.org/gulpjs/vinyl-sourcemap +[travis-image]: http://img.shields.io/travis/gulpjs/vinyl-sourcemap.svg?label=travis-ci + +[appveyor-url]: https://ci.appveyor.com/project/gulpjs/vinyl-sourcemap +[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/vinyl-sourcemap.svg?label=appveyor + +[coveralls-url]: https://coveralls.io/r/gulpjs/vinyl-sourcemap +[coveralls-image]: http://img.shields.io/coveralls/gulpjs/vinyl-sourcemap/master.svg + +[gitter-url]: https://gitter.im/gulpjs/gulp +[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png diff --git a/package.json b/package.json index 99a3199..0e985cc 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "vinyl-sourcemap", "version": "0.3.0", - "description": "Add sourcemaps to Vinyl files.", + "description": "Add/write sourcemaps to/from Vinyl files.", "author": "Gulp Team (http://gulpjs.com/)", "contributors": [ "Robin Venneman",