Compare commits

...

5 Commits

Author SHA1 Message Date
156088db99 chore: release version v0.8.8 2017-07-21 09:30:10 -07:00
9c0c648001 chore: update contributors 2017-07-21 09:30:10 -07:00
a2934aa371 chore: update ci 2017-07-21 09:29:12 -07:00
ac98b7582a chore: update deps 2017-07-21 09:29:06 -07:00
0dc3c14f2b docs: update readme 2017-07-09 10:05:03 +01:00
4 changed files with 22 additions and 26 deletions

View File

@ -7,19 +7,19 @@ matrix:
env: CXX=g++-4.8
- node_js: 6
env:
- SAUCE=true
- CXX=g++-4.8
- node_js: stable
env: CXX=g++-4.8
# Make sure we have new NPM.
before_install:
- npm install -g npm
- npm install -g npm@4
script:
- npm run lint
- npm test
- npm run coverage
- make test
before_script:
- export DISPLAY=:99.0
@ -29,7 +29,7 @@ after_success:
- npm run coverage-publish
addons:
firefox: latest
firefox: 'latest'
apt:
sources:
- ubuntu-toolchain-r-test

View File

@ -9,8 +9,6 @@
![](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/ipfs-js-peer-id.svg)](https://saucelabs.com/u/ipfs-js-peer-id)
> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
- [Description](#description)
@ -44,25 +42,21 @@
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
*A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a
public key.*
A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a public key.
*The public key is a base64 encoded string of a protobuf containing an RSA DER
buffer. This uses a node buffer to pass the base64 encoded public key protobuf
to the multihash for ID generation.*
The public key is a base64 encoded string of a protobuf containing an RSA DER buffer. This uses a node buffer to pass the base64 encoded public key protobuf to the multihash for ID generation.
# Example
```js
var PeerId = require('peer-id')
var bs58 = require('bs58')
```JavaScript
const PeerId = require('peer-id')
PeerId.create({ bits: 1024 }, (err, id) => {
if (err) { throw err }
console.log(JSON.stringify(id.toJSON(), null, 2))
})
```
```
```bash
{
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
@ -83,7 +77,7 @@ PeerId.create({ bits: 1024 }, (err, id) => {
## Node.js
```js
var PeerId = require('peer-id')
const PeerId = require('peer-id')
```
## Browser: Browserify, Webpack, other bundlers
@ -94,7 +88,7 @@ it and use with your favourite bundler without having to adjust asset management
process.
```js
var PeerId = require('peer-id')
const PeerId = require('peer-id')
```
## Browser: `<script>` Tag

View File

@ -5,8 +5,10 @@ machine:
dependencies:
pre:
- google-chrome --version
- wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
- sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
- curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
- sudo dpkg -i google-chrome.deb || true
- sudo apt-get update
- sudo apt-get --only-upgrade install google-chrome-stable
- sudo apt-get install -f
- sudo apt-get install --only-upgrade lsb-base
- sudo dpkg -i google-chrome.deb
- google-chrome --version

View File

@ -1,6 +1,6 @@
{
"name": "peer-id",
"version": "0.8.7",
"version": "0.8.8",
"description": "IPFS Peer Id implementation in Node.js",
"main": "src/index.js",
"bin": "src/bin.js",
@ -34,14 +34,14 @@
},
"homepage": "https://github.com/libp2p/js-peer-id",
"devDependencies": {
"aegir": "^11.0.1",
"chai": "^3.5.0",
"dirty-chai": "^1.2.2",
"aegir": "^11.0.2",
"chai": "^4.1.0",
"dirty-chai": "^2.0.1",
"pre-commit": "^1.2.2"
},
"dependencies": {
"async": "^2.3.0",
"libp2p-crypto": "~0.8.7",
"async": "^2.5.0",
"libp2p-crypto": "~0.8.8",
"lodash": "^4.17.4",
"multihashes": "~0.4.5"
},