mirror of
https://github.com/fluencelabs/js-libp2p-interfaces
synced 2025-05-17 06:01:31 +00:00
update name
This commit is contained in:
parent
11bce9a818
commit
2af97d4e79
10
README.md
10
README.md
@ -1,9 +1,9 @@
|
||||
abstract-connection
|
||||
interface-connection
|
||||
==================
|
||||
|
||||
[](http://ipn.io) [](http://webchat.freenode.net/?channels=%23ipfs)
|
||||
|
||||
> A test suite and interface you can use to implement a connection. A connection is understood as something that offers mechanism for writing and reading data, back pressure, half and full duplex streams. This module and test suite were heavily inspired by abstract-blob-store and abstract-stream-muxer.
|
||||
> A test suite and interface you can use to implement a connection. A connection is understood as something that offers mechanism for writing and reading data, back pressure, half and full duplex streams. This module and test suite were heavily inspired by abstract-blob-store and interface-stream-muxer.
|
||||
|
||||
The primary goal of module is to enable developers to pick, swap or upgrade their connection without loosing the same API expectations and mechanisms such as back pressure and the hability to half close a connection.
|
||||
|
||||
@ -20,9 +20,9 @@ The API is presented with both Node.js and Go primitives, however, there is not
|
||||
|
||||
# Badge
|
||||
|
||||
Include this badge in your readme if you make a module that is compatible with the abstract-connection API. You can validate this by running the tests.
|
||||
Include this badge in your readme if you make a module that is compatible with the interface-connection API. You can validate this by running the tests.
|
||||
|
||||

|
||||

|
||||
|
||||
# How to use the battery of tests
|
||||
|
||||
@ -30,7 +30,7 @@ Include this badge in your readme if you make a module that is compatible with t
|
||||
|
||||
```
|
||||
var tape = require('tape')
|
||||
var tests = require('abstract-connection/tests')
|
||||
var tests = require('interface-connection/tests')
|
||||
var YourConnectionHandler = require('../src')
|
||||
|
||||
var common = {
|
||||
|
@ -1,10 +1,10 @@
|
||||
{
|
||||
"name": "abstract-connection",
|
||||
"name": "interface-connection",
|
||||
"version": "0.0.2",
|
||||
"description": "A test suite and interface you can use to implement a connection interface.",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/diasdavid/abstract-connection.git"
|
||||
"url": "https://github.com/diasdavid/interface-connection.git"
|
||||
},
|
||||
"keywords": [
|
||||
"IPFS"
|
||||
@ -12,9 +12,9 @@
|
||||
"author": "David Dias <daviddias@ipfs.io>",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/diasdavid/abstract-connection/issues"
|
||||
"url": "https://github.com/diasdavid/interface-connection/issues"
|
||||
},
|
||||
"homepage": "https://github.com/diasdavid/abstract-connection",
|
||||
"homepage": "https://github.com/diasdavid/interface-connection",
|
||||
"dependencies": {
|
||||
"timed-tape": "^0.1.0"
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user