Skip to content
This repository was archived by the owner on Feb 26, 2021. It is now read-only.

Update redirects to libp2p #25

Merged
merged 1 commit into from
Oct 2, 2016
Merged
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ peer-info JavaScript implementation
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)

> A PeerInfo object contains information about a
> [PeerID](https://github.com/diasdavid/js-peer-id) and its
> [multiaddrs](https://github.com/jbenet/js-multiaddr). This module is used by
> [PeerID](https://github.com/libp2p/js-peer-id) and its
> [multiaddrs](https://github.com/libp2p/js-multiaddr). This module is used by
> [IPFS](https://github.com/ipfs/ipfs) and
> [libp2p](https://github.com/diasdavid/js-libp2p).
> [libp2p](https://github.com/libp2p/js-libp2p).

# Example

Expand Down Expand Up @@ -41,7 +41,7 @@ const PeerInfo = require('peer-info')
## const peer = new PeerInfo()

Creates a new PeerInfo instance and also generates a new underlying
[PeerID](https://github.com/diasdavid/js-peer-id) for it.
[PeerID](https://github.com/libp2p/js-peer-id) for it.

## const peer = new PeerInfo(peerId)

Expand All @@ -54,7 +54,7 @@ A list of multiaddresses instances that `peer` can be reached at.
## peer.multiaddr.add(addr)

Adds a new multiaddress that `peer` can be reached at. `addr` is an instance of
a [multiaddr](https://github.com/jbenet/js-multiaddr).
a [multiaddr](https://github.com/libp2p/js-multiaddr).

## peer.multiaddr.addSafe(addr)

Expand Down