feat: initial commit

This commit is contained in:
Jacob Heun 2019-10-18 13:33:30 +02:00
commit 584a69b181
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F
4 changed files with 113 additions and 0 deletions

14
.gitignore vendored Normal file
View File

@ -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

21
LICENSE Normal file
View File

@ -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.

39
README.md Normal file
View File

@ -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

39
package.json Normal file
View File

@ -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"
}
}