From 514bd20376da6c6152a71592114147d8354bea1e Mon Sep 17 00:00:00 2001 From: Luke Childs Date: Wed, 8 May 2019 15:38:06 +0700 Subject: [PATCH] Initial commit --- .gitignore | 5 +++++ .travis.yml | 8 ++++++++ LICENSE | 21 +++++++++++++++++++++ README.md | 19 +++++++++++++++++++ package.json | 36 ++++++++++++++++++++++++++++++++++++ src/index.js | 3 +++ test/unit.js | 6 ++++++ 7 files changed, 98 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 package.json create mode 100644 src/index.js create mode 100644 test/unit.js diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7fd69e0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +node_modules +.nyc_output +npm-debug.log +package-lock.json +yarn.lock diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..2bde09e --- /dev/null +++ b/.travis.yml @@ -0,0 +1,8 @@ +language: node_js +node_js: + - '8' +script: npm test +after_success: npm run coverage +notifications: + email: + on_success: never diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f080f1b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Luke Childs + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..40a3826 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# vainjs + +> A JavaScript vanity address generator + +[![Build Status](https://travis-ci.com/lukechilds/vainjs.svg?branch=master)](https://travis-ci.com/lukechilds/vainjs) +[![Coverage Status](https://coveralls.io/repos/github/lukechilds/vainjs/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/vainjs?branch=master) +[![npm](https://img.shields.io/npm/v/vainjs.svg)](https://www.npmjs.com/package/vainjs) + +Generates vanity addresses for a wide range of address formats. + +## Install + +```shell +npm install vainjs +``` + +## License + +MIT © Luke Childs diff --git a/package.json b/package.json new file mode 100644 index 0000000..2189a62 --- /dev/null +++ b/package.json @@ -0,0 +1,36 @@ +{ + "name": "vainjs", + "version": "0.0.0", + "description": "A JavaScript vanity address generator", + "main": "src/index.js", + "engines": { + "node": ">=8" + }, + "scripts": { + "test": "xo && nyc ava", + "coverage": "nyc report --reporter=text-lcov | coveralls" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/lukechilds/vainjs.git" + }, + "keywords": [ + "vanity", + "address", + "bitcoin", + "cryptocurrency" + ], + "author": "Luke Childs (http://lukechilds.co.uk)", + "license": "MIT", + "bugs": { + "url": "https://github.com/lukechilds/vainjs/issues" + }, + "homepage": "https://github.com/lukechilds/vainjs#readme", + "devDependencies": { + "ava": "^0.25.0", + "coveralls": "^3.0.2", + "nyc": "^13.1.0", + "xo": "^0.23.0" + }, + "dependencies": {} +} diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..eb38033 --- /dev/null +++ b/src/index.js @@ -0,0 +1,3 @@ +const vanity = () => {}; + +module.exports = vanity; diff --git a/test/unit.js b/test/unit.js new file mode 100644 index 0000000..8a8bf8b --- /dev/null +++ b/test/unit.js @@ -0,0 +1,6 @@ +import test from 'ava'; +import vanity from '..'; + +test('vanity is exported', t => { + t.not(vanity, undefined); +});