From 584a69b181a5fcd156793bc59da81cbb1f1e6185 Mon Sep 17 00:00:00 2001 From: Jacob Heun Date: Fri, 18 Oct 2019 13:33:30 +0200 Subject: [PATCH] feat: initial commit --- .gitignore | 14 ++++++++++++++ LICENSE | 21 +++++++++++++++++++++ README.md | 39 +++++++++++++++++++++++++++++++++++++++ package.json | 39 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 113 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 package.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..fad1fce3b --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +**/node_modules/ +**/*.log + +# Coverage directory used by tools like istanbul +.nyc_output + +build +dist + +# Dependency directory +# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git +node_modules +# Lock files +package-lock.json diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..664e6c60f --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2017 Protocol Labs Inc. + +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 000000000..66655c96e --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# JS Libp2p Interfaces + +[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai) +[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/) +[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p) +[![](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io) + +> Contains test suites and interfaces you can use to implement the various components of libp2p. + +## Interfaces + +- [Connection](./connection) +- [Content Routing](./content-routing) +- [Peer Discovery](./peer-discovery) +- [Peer Routing](./peer-routing) +- [Stream Muxer](./stream-muxer) +- [Transport](./transport) + +### Origin Repositories + +For posterity, here is a link to the original repositories for each of the interfaces (if they had one). +- [Connection](https://github.com/libp2p/interface-connection) +- [Content Routing](https://github.com/libp2p/interface-content-routing) +- [Peer Discovery](https://github.com/libp2p/interface-peer-discovery) +- [Peer Routing](https://github.com/libp2p/interface-peer-routing) +- [Stream Muxer](https://github.com/libp2p/interface-stream-muxer) +- [Transport](https://github.com/libp2p/interface-transport) + +## Contribute + +Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-interfaces/issues)! + +This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). + +[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md) + +## License + +MIT - Protocol Labs 2019 diff --git a/package.json b/package.json new file mode 100644 index 000000000..23bc61921 --- /dev/null +++ b/package.json @@ -0,0 +1,39 @@ +{ + "name": "libp2p-interfaces", + "version": "0.0.1", + "description": "Interfaces for JS Libp2p", + "main": "src/index.js", + "files": [ + "src", + "dist" + ], + "scripts": { + "lint": "aegir lint", + "build": "aegir build", + "test": "aegir test", + "test:node": "aegir test --target node", + "test:browser": "aegir test --target browser", + "release": "aegir release -t node -t browser", + "release-minor": "aegir release --type minor -t node -t browser", + "release-major": "aegir release --type major -t node -t browser" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/libp2p/js-interfaces.git" + }, + "keywords": [ + "libp2p", + "interface" + ], + "author": "", + "license": "MIT", + "bugs": { + "url": "https://github.com/libp2p/js-interfaces/issues" + }, + "homepage": "https://github.com/libp2p/js-interfaces#readme", + "dependencies": { + }, + "devDependencies": { + "aegir": "^20.4.1" + } +}