From c121fd83fac0f7757bbee228301b297f5a69d8a7 Mon Sep 17 00:00:00 2001 From: David Dias Date: Fri, 11 Dec 2015 20:44:47 -0800 Subject: [PATCH] update name --- README.md | 16 ++++++++-------- package.json | 8 ++++---- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ec31bef..1ba1fb5 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -abstract-transport +interface-transport =================== [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) > A test suite and interface you can use to implement a transport. A transport is understood as something that offers a dial+listen interface -The primary goal of this module is to enable developers to pick and swap their Record Store module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by abstract-blob-store and abstract-stream-muxer. +The primary goal of this module is to enable developers to pick and swap their Record Store module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by abstract-blob-store and interface-stream-muxer. Publishing a test suite as a module lets multiple modules all ensure compatibility since they use the same test suite. -The purpose of this abstraction is not to reinvent any wheels when it comes to dialing and listening to transports, instead, it tries to uniform several transports through a shimmed interface. +The purpose of this interfaceion is not to reinvent any wheels when it comes to dialing and listening to transports, instead, it tries to uniform several transports through a shimmed interface. The API is presented with both Node.js and Go primitives, however, there is not actual limitations for it to be extended for any other language, pushing forward the cross compatibility and interop through diferent stacks. @@ -21,9 +21,9 @@ note: for any new given implementation that adds one more option to the multiadd # Badge -Include this badge in your readme if you make a module that is compatible with the abstract-transport 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-transport API. You can validate this by running the tests. -![](https://raw.githubusercontent.com/diasdavid/abstract-transport/master/img/badge.png) +![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png) # How to use the battery of tests @@ -31,7 +31,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-transport/tests') +var tests = require('interface-transport/tests') var YourTransportHandler = require('../src') var common = { @@ -62,7 +62,7 @@ This method dials a transport to the Peer referenced by the peerInfo object. multiaddr must be of the type [`multiaddr`](http://npmjs.org/multiaddr). -`stream` must implements the [abstract-connection](https://github.com/diasdavid/abstract-connection) interface. +`stream` must implements the [interface-connection](https://github.com/diasdavid/interface-connection) interface. `[options]` are not mandatory fields for all the implementations that might be passed for certain implementations for them to work (e.g. a Signalling Server for a WebRTC transport implementation) @@ -72,7 +72,7 @@ multiaddr must be of the type [`multiaddr`](http://npmjs.org/multiaddr). This method waits and listens for incoming transports by other peers. -`stream` must be a stream that implements the [abstract-connection](https://github.com/diasdavid/abstract-connection) interface. +`stream` must be a stream that implements the [interface-connection](https://github.com/diasdavid/interface-connection) interface. Options are the properties this listener must have access in order to properly listen on a given transport/socket diff --git a/package.json b/package.json index e2c0cd8..f0a1e62 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { - "name": "abstract-transport", + "name": "interface-transport", "version": "0.1.0", "description": "A test suite and interface you can use to implement a transport.", "repository": { "type": "git", - "url": "https://github.com/diasdavid/abstract-transport.git" + "url": "https://github.com/diasdavid/interface-transport.git" }, "keywords": [ "IPFS" @@ -12,9 +12,9 @@ "author": "David Dias ", "license": "MIT", "bugs": { - "url": "https://github.com/diasdavid/abstract-transport/issues" + "url": "https://github.com/diasdavid/interface-transport/issues" }, - "homepage": "https://github.com/diasdavid/abstract-transport", + "homepage": "https://github.com/diasdavid/interface-transport", "devDependencies": {}, "dependencies": { "multiaddr": "^1.0.0",