add skeleton

This commit is contained in:
Friedel Ziegelmayer 2016-05-20 21:29:53 +02:00
parent 57c97603e8
commit 13d8336042
8 changed files with 171 additions and 9 deletions

18
.gitignore vendored
View File

@ -1,7 +1,12 @@
**/node_modules/
**/*.log
test/repo-tests*
# Logs
logs
*.log
npm-debug.log*
coverage
# Runtime data
pids
@ -20,14 +25,11 @@ coverage
# node-waf configuration
.lock-wscript
# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
build
# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules
# Optional npm cache directory
.npm
# Optional REPL history
.node_repl_history
lib
dist

34
.npmignore Normal file
View File

@ -0,0 +1,34 @@
**/node_modules/
**/*.log
test/repo-tests*
# Logs
logs
*.log
coverage
# Runtime data
pids
*.pid
*.seed
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# node-waf configuration
.lock-wscript
build
# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules
test

34
.travis.yml Normal file
View File

@ -0,0 +1,34 @@
sudo: false
language: node_js
node_js:
- 4
- 5
- stable
# Make sure we have new NPM.
before_install:
- npm install -g npm
script:
- npm run lint
- npm test
- npm run coverage
before_script:
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
after_success:
- npm run coverage-publish
env:
- CXX=g++-4.8
addons:
firefox: 'latest'
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- g++-4.8

View File

@ -1,2 +1,18 @@
# js-libp2p-secio
Secio implementation in JavaScript
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Coverage Status](https://coveralls.io/repos/github/ipfs/js-libp2p-secio/badge.svg?branch=master)](https://coveralls.io/github/ipfs/js-libp2p-secio?branch=master)
[![Travis CI](https://travis-ci.org/ipfs/js-libp2p-secio.svg?branch=master)](https://travis-ci.org/ipfs/js-libp2p-secio)
[![Circle CI](https://circleci.com/gh/ipfs/js-libp2p-secio.svg?style=svg)](https://circleci.com/gh/ipfs/js-libp2p-secio)
[![Dependency Status](https://david-dm.org/ipfs/js-libp2p-secio.svg?style=flat-square)](https://david-dm.org/ipfs/js-libp2p-secio) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
> Secio implementation in JavaScript
## Description
This repo contains the JavaScript implementation of secio, an encryption protocol used in libp2p. This is based on this [go implementation](https://github.com/ipfs/go-libp2p-secio).
## API

12
circle.yml Normal file
View File

@ -0,0 +1,12 @@
machine:
node:
version: stable
dependencies:
pre:
- google-chrome --version
- wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
- sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
- sudo apt-get update
- sudo apt-get --only-upgrade install google-chrome-stable
- google-chrome --version

49
package.json Normal file
View File

@ -0,0 +1,49 @@
{
"name": "libp2p-secio",
"version": "0.1.0",
"description": "Secio implementation in JavaScript",
"main": "lib/index.js",
"jsnext:main": "src/index.js",
"scripts": {
"lint": "aegir-lint",
"build": "aegir-build",
"test": "aegir-test",
"test:node": "aegir-test --env node",
"test:browser": "aegir-test --env browser",
"release": "aegir-release",
"release-minor": "aegir-release --type minor",
"release-major": "aegir-release --type major",
"coverage": "aegir-coverage",
"coverage-publish": "aegir-coverage publish"
},
"keywords": [
"IPFS",
"libp2p",
"crypto",
"rsa"
],
"author": "Friedel Ziegelmayer <dignifiedqurie@gmail.com>",
"license": "MIT",
"dependencies": {
},
"devDependencies": {
"aegir": "^3.0.4",
"chai": "^3.5.0",
"pre-commit": "^1.1.3"
},
"pre-commit": [
"lint",
"test"
],
"engines": {
"node": "^4.0.0"
},
"repository": {
"type": "git",
"url": "https://github.com/ipfs/js-libp2p-secio.git"
},
"bugs": {
"url": "https://github.com/ipfs/js-libp2p-secio/issues"
},
"homepage": "https://github.com/ipfs/js-libp2p-secio"
}

3
src/index.js Normal file
View File

@ -0,0 +1,3 @@
'use strict'
module.exports = {}

12
test/index.spec.js Normal file
View File

@ -0,0 +1,12 @@
/* eslint-env mocha */
'use strict'
const expect = require('chai').expect
const secio = require('../src')
describe('libp2p-secio', () => {
it('exists', () => {
expect(secio).to.exist
})
})