diff --git a/.editorconfig b/.editorconfig index 1ff40e6..2eed47c 100644 --- a/.editorconfig +++ b/.editorconfig @@ -3,20 +3,15 @@ root = true [*] indent_style = space +indent_size = 2 end_of_line = lf charset = utf-8 -indent_size = 2 trim_trailing_whitespace = true insert_final_newline = true [*.md] trim_trailing_whitespace = false -insert_final_newline = false -[{,test/}{actual,fixtures}/**] -trim_trailing_whitespace = false -insert_final_newline = false - -[templates/**] -trim_trailing_whitespace = false +[test/fixtures/*] insert_final_newline = false +trim_trailing_whitespace = false \ No newline at end of file diff --git a/.gitattributes b/.gitattributes index 660957e..4a3f1d3 100644 --- a/.gitattributes +++ b/.gitattributes @@ -7,4 +7,4 @@ *.jpg binary *.gif binary *.png binary -*.jpeg binary +*.jpeg binary \ No newline at end of file diff --git a/.jshintrc b/.jshintrc index 1a2f7b9..6e5a84a 100644 --- a/.jshintrc +++ b/.jshintrc @@ -15,4 +15,4 @@ "sub": true, "undef": true, "unused": true -} +} \ No newline at end of file diff --git a/.verb.md b/.verb.md index cc797c2..bd6b91b 100644 --- a/.verb.md +++ b/.verb.md @@ -1,8 +1,7 @@ -# {%= name %} {%= badge("fury") %} +# {%= name %} {%= badge("fury") %} {%= badge("travis") %} > {%= description %} -## Install {%= include("install-npm", {save: true}) %} ## Usage diff --git a/README.md b/README.md new file mode 100644 index 0000000..5484a34 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# npm-base [![NPM version](https://badge.fury.io/js/npm-base.svg)](http://badge.fury.io/js/npm-base) [![Build Status](https://travis-ci.org/doowb/npm-base.svg)](https://travis-ci.org/doowb/npm-base) + +> Base class for downloading data from the npm registry + +## Install with [npm](npmjs.org) + +```bash +npm i npm-base --save +``` + +## Usage + +```js +var npmBase = require('npm-base'); +``` + +## API + +{%= apidocs("index.js") %} + +## Related projects + +{%= related([]) %} + +## Running tests +Install dev dependencies. + +```bash +npm i -d && npm test +``` + + +## Contributing +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/doowb/npm-base/issues) + + +## Author + +**Brian Woodward** + ++ [github/doowb](https://github.com/doowb) ++ [twitter/doowb](http://twitter.com/doowb) + +## License +Copyright © 2015 Brian Woodward +Released under the MIT license + +*** + +_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on October 31, 2015._ diff --git a/package.json b/package.json index 3b3a301..2027b44 100644 --- a/package.json +++ b/package.json @@ -19,10 +19,7 @@ "scripts": { "test": "mocha" }, - "dependencies": {}, "devDependencies": { - "mocha": "*", - "should": "*" - }, - "keywords": [] -} + "mocha": "*" + } +} \ No newline at end of file