Skip to content

Commit

Permalink
fix: code review
Browse files Browse the repository at this point in the history
  • Loading branch information
vasco-santos committed Jun 21, 2018
1 parent 2d79059 commit 3afa02c
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ipns
# IPNS

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
Expand Down Expand Up @@ -36,7 +36,7 @@ This module contains all the necessary code for creating, understanding and vali
#### Create record

```js
const ipns = require('./ipns')
const ipns = require('ipns')

ipns.create(privateKey, value, seqNumber, eol, (err, entryData) => {
// your code goes here
Expand All @@ -46,7 +46,7 @@ ipns.create(privateKey, value, seqNumber, eol, (err, entryData) => {
#### Validate record

```js
const ipns = require('./ipns')
const ipns = require('ipns')

ipns.validate(publicKey, ipnsEntry, (err) => {
// your code goes here
Expand All @@ -65,7 +65,7 @@ ipns.validate(publicKey, ipnsEntry, (err) => {
#### Datastore key

```js
const ipns = require('./ipns')
const ipns = require('ipns')

ipns.getDatastoreKey(peerId);
```
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"chai": "^4.1.2",
"chai-string": "^1.4.0",
"dirty-chai": "^2.0.1",
"ipfs": "^0.28.2",
"ipfs": "^0.29.3",
"ipfsd-ctl": "^0.36.0",
"libp2p-crypto": "^0.13.0",
"multihashes": "^0.4.13"
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const ipnsEntryProto = require('./pb/ipns.proto')
const ERRORS = require('./errors')

/**
* Create creates a new ipns entry and signs it with the given private key.
* Creates a new ipns entry and signs it with the given private key.
* Note: This function does not embed the public key. If you want to do that, use `EmbedPublicKey`.
*
* @param {Object} privateKey private key for signing the record.
Expand Down
2 changes: 2 additions & 0 deletions test/index.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ const ipns = require('../src')
const df = DaemonFactory.create({ type: 'proc', exec: ipfs })

describe('ipns', function () {
this.timeout(20 * 1000)

const cid = 'QmWEekX7EZLUd9VXRNMRXW3LXe4F6x7mB8oPxY5XLptrBq'

let ipfs = null
Expand Down

0 comments on commit 3afa02c

Please sign in to comment.