Skip to content

Commit 4f520b1

Browse files
committed
chore: rename master to main
1 parent 1d46a08 commit 4f520b1

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

.github/workflows/js-test-and-release.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: test & maybe release
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77
pull_request:
88
workflow_dispatch:
99

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
44
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
55
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipns.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipns)
6-
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipns/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipns/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipns/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/js-ipns/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
77

88
> IPNS Record definitions
99
@@ -144,7 +144,7 @@ ipns.create(privateKey, value, sequenceNumber, lifetime, options)
144144

145145
Create an IPNS record for being stored in a protocol buffer.
146146

147-
- `privateKey` (`PrivKey` [RSA Instance](https://github.com/libp2p/js-libp2p-crypto/blob/master/src/keys/rsa-class.js)): key to be used for cryptographic operations.
147+
- `privateKey` ([PrivateKey](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.keys.PrivateKey.html)): key to be used for cryptographic operations.
148148
- `value` (string): IPFS path of the object to be published.
149149
- `sequenceNumber` (Number): number representing the current version of the record.
150150
- `lifetime` (Number): lifetime of the record (in milliseconds).
@@ -160,7 +160,7 @@ ipns.validate(publicKey, ipnsRecord)
160160

161161
Validate an IPNS record previously stored in a protocol buffer.
162162

163-
- `publicKey` (`PubKey` [RSA Instance](https://github.com/libp2p/js-libp2p-crypto/blob/master/src/keys/rsa-class.js)): key to be used for cryptographic operations.
163+
- `publicKey` ([PublicKey](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.keys.PublicKey.html)): key to be used for cryptographic operations.
164164
- `ipnsRecord` (`IPNSRecord`): IPNS record (obtained using the create function).
165165

166166
Returns a `Promise`, which may be rejected if the validation was not successful.
@@ -193,7 +193,7 @@ const publicKey = await ipns.extractPublicKey(peerId, ipnsRecord)
193193

194194
Extract a public key from an IPNS record.
195195

196-
- `peerId` (`PeerId` [Instance](https://github.com/libp2p/js-libp2p-peer-id/tree/master/packages/libp2p-peer-id)): peer identifier object.
196+
- `peerId` ([PeerId](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.peer_id.PeerId.html)): peer identifier object.
197197
- `ipnsRecord` (`IPNSRecord`): ipns record (obtained using the create function).
198198

199199
Returns a `Promise` which resolves to public key ([`PublicKey`](https://github.com/libp2p/js-libp2p-interfaces/blob/master/packages/interface-keys/src/index.ts) ): may be used for cryptographic operations.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
},
6666
"release": {
6767
"branches": [
68-
"master"
68+
"main"
6969
],
7070
"plugins": [
7171
[

0 commit comments

Comments
 (0)