Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
robertoachar committed Jul 22, 2017
0 parents commit 326b434
Show file tree
Hide file tree
Showing 16 changed files with 4,559 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .editorconfig
@@ -0,0 +1,14 @@
# http://editorconfig.org
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
max_line_length = off
trim_trailing_whitespace = false
1 change: 1 addition & 0 deletions .eslintignore
@@ -0,0 +1 @@
node_modules
26 changes: 26 additions & 0 deletions .eslintrc
@@ -0,0 +1,26 @@
{
"extends": "eslint:recommended",
"env": {
"es6": true,
"jest": true,
"node": true
},
"rules": {
"indent": [
"error",
2
],
"linebreak-style": [
"error",
"unix"
],
"quotes": [
"error",
"single"
],
"semi": [
"error",
"always"
]
}
}
1 change: 1 addition & 0 deletions .gitattributes
@@ -0,0 +1 @@
* text=auto eol=lf
16 changes: 16 additions & 0 deletions .gitignore
@@ -0,0 +1,16 @@
# Logs
logs
*.log
npm-debug.log*

# Coverage directory used by tools like istanbul
coverage

# Dependency directories
node_modules/

# Output of 'npm pack'
*.tgz

# OSX
.DS_Store
1 change: 1 addition & 0 deletions .npmrc
@@ -0,0 +1 @@
save-exact = true
18 changes: 18 additions & 0 deletions .travis.yml
@@ -0,0 +1,18 @@
language: node_js

node_js:
- "6"

install:
- npm install

script:
- npm test

after_script:
- npm run coveralls

notifications:
email:
on_success: never
on_failure: always
5 changes: 5 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,5 @@
# Changelog

## 1.0.0

* Initial release
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 Roberto Achar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
85 changes: 85 additions & 0 deletions README.md
@@ -0,0 +1,85 @@
# node-file-hash

Generated by [OSS Project Generator](http://bit.ly/generator-oss-project).

[![Travis Status][travis-badge]][travis-url]
[![AppVeyor Status][appveyor-badge]][appveyor-url]
[![CircleCI Status][circleci-badge]][circleci-url]
[![Coveralls Status][coveralls-badge]][coveralls-url]
[![NPM Version][npm-badge]][npm-url]
[![License][license-badge]][license-url]

> Create a hash for file identification.
Long description.

# Installation

Install package

```bash
$ npm install --save node-file-hash
```

# Usage

Say `It works!`

```js
const lib = require('node-file-hash');

lib.hello((err, message) => {
if (err) return console.error(err);

console.log(message);
});
```

# Development

* Cloning the repo

```bash
$ git clone https://github.com/robertoachar/node-file-hash.git
```

* Installing dependencies

```bash
$ npm install
```

* Running scripts

Action | Usage
--- | ---
Starting development mode | `npm start`
Linting code | `npm run lint`
Running unit tests | `npm run jest`
Running code coverage | `npm run coverage`
Running lint + tests | `npm test`
Sending coverage results to Coveralls.io | `npm run coveralls`

# Author
[Roberto Achar](https://twitter.com/robertoachar)

# License
[MIT](https://github.com/robertoachar/node-file-hash/blob/master/LICENSE)

[travis-badge]: https://travis-ci.org/robertoachar/node-file-hash.svg?branch=master
[travis-url]: https://travis-ci.org/robertoachar/node-file-hash

[appveyor-badge]: https://ci.appveyor.com/api/projects/status/github/robertoachar/node-file-hash?branch=master&svg=true
[appveyor-url]: https://ci.appveyor.com/project/robertoachar/node-file-hash

[circleci-badge]: https://circleci.com/gh/robertoachar/node-file-hash/tree/master.svg?style=shield
[circleci-url]: https://circleci.com/gh/robertoachar/node-file-hash

[coveralls-badge]: https://coveralls.io/repos/github/robertoachar/node-file-hash/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/robertoachar/node-file-hash?branch=master

[npm-badge]: https://img.shields.io/npm/v/node-file-hash.svg
[npm-url]: https://www.npmjs.com/package/node-file-hash

[license-badge]: https://img.shields.io/github/license/robertoachar/node-file-hash.svg
[license-url]: https://opensource.org/licenses/MIT
13 changes: 13 additions & 0 deletions appveyor.yml
@@ -0,0 +1,13 @@
environment:
nodejs_version: "6"

install:
- ps: Install-Product node $env:nodejs_version
- npm install

test_script:
- node --version
- npm --version
- npm test

build: off
11 changes: 11 additions & 0 deletions circle.yml
@@ -0,0 +1,11 @@
machine:
node:
version: 6.11.1

dependencies:
override:
- npm install

test:
override:
- npm test

0 comments on commit 326b434

Please sign in to comment.