Skip to content
This repository has been archived by the owner on Oct 19, 2022. It is now read-only.

feat: ready for next aegir #25

Merged
merged 1 commit into from
Nov 3, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,4 @@ build/Release
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules

lib
dist
dist
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@
[![](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/multiformats/js-multistream-select/badge.svg?branch=master)](https://coveralls.io/github/multiformats/js-multistream-select?branch=master)
[![Travis CI](https://travis-ci.org/multiformats/js-multistream-select.svg?branch=master)](https://travis-ci.org/diasdavid/js-multistream)
[![Circle CI](https://circleci.com/gh/multiformats/js-multistream-select.svg?style=svg)](https://circleci.com/gh/diasdavid/js-multistream)
[![Dependency Status](https://david-dm.org/multiformats/js-multistream-select.svg?style=flat-square)](https://david-dm.org/diasdavid/js-multistream) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
[![Travis CI](https://travis-ci.org/multiformats/js-multistream-select.svg?branch=master)](https://travis-ci.org/multiformats/js-multistream-select)
[![Circle CI](https://circleci.com/gh/multiformats/js-multistream-select.svg?style=svg)](https://circleci.com/gh/multiformats/js-multistream-select)
[![Dependency Status](https://david-dm.org/multiformats/js-multistream-select.svg?style=flat-square)](https://david-dm.org/multiformats/js-multistream-select) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
![](https://img.shields.io/badge/Node.js-%3E%3D4.0.0-orange.svg?style=flat-square)

[![Sauce Test Status](https://saucelabs.com/browser-matrix/js-ms-select.svg)](https://saucelabs.com/u/js-ms-select)

> JavaScript implementation of [multistream-select](https://github.com/multiformats/multistream-select).

Expand Down Expand Up @@ -105,7 +109,7 @@ the global namespace.
const Multistream = require('multistream-select')

const ms = new multistream.Listener()
// or
// or
const ms = new multistream.Dialer()

// apply the multistream to the conn
Expand Down Expand Up @@ -134,7 +138,7 @@ ms.select(<protocol>, <callback>)
```

- `protocol` is a string of the protocol that we want to handshake.
- `callback` is a function of type `function (err, conn)` where `err` is an error object that gets passed if something wrong happend (e.g: if the protocol selected is not supported by the other end) and conn is the connection handshaked with the other end.
- `callback` is a function of type `function (err, conn)` where `err` is an error object that gets passed if something wrong happend (e.g: if the protocol selected is not supported by the other end) and conn is the connection handshaked with the other end.

### Listing the available protocols

Expand Down Expand Up @@ -179,7 +183,7 @@ Captain: [@diasdavid](https://github.com/diasdavid).

## Contribute

Contributions welcome. Please check out [the issues](https://github.com/multiformats/js-multistream/issues).
Contributions welcome. Please check out [the issues](https://github.com/multiformats/js-multistream-select/issues).

Check out our [contributing document](https://github.com/multiformats/multiformats/blob/master/contributing.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

Expand Down
10 changes: 4 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
"name": "multistream-select",
"version": "0.11.1",
"description": "JavaScript implementation of the multistream spec",
"main": "lib/index.js",
"jsnext:main": "src/index.js",
"main": "src/index.js",
"scripts": {
"lint": "aegir-lint",
"test": "aegir-test",
Expand All @@ -18,7 +17,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/diasdavid/js-multistream.git"
"url": "git+https://github.com/multiformats/js-multistream-select.git"
},
"pre-commit": [
"lint",
Expand All @@ -36,12 +35,11 @@
"labs"
],
"engines": {
"node": "^4.4.0"
"node": ">=4.0.0"
},
"author": "David Dias <[email protected]>",
"license": "MIT",
"dependencies": {
"babel-runtime": "^6.11.6",
"debug": "^2.2.0",
"interface-connection": "^0.2.1",
"lodash.isfunction": "^3.0.8",
Expand All @@ -52,7 +50,7 @@
"varint": "^4.0.1"
},
"devDependencies": {
"aegir": "^8.0.0",
"aegir": "^9.0.1",
"chai": "^3.5.0",
"pre-commit": "^1.1.3",
"pull-pair": "^1.1.0",
Expand Down