Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: correct case for RSA keyType #136

Merged
merged 2 commits into from Jan 6, 2021
Merged

docs: correct case for RSA keyType #136

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff2260d
docs: correct case for RSA keyType
acolytec3 Jan 6, 2021
750340b
docs: update default to RSA from 'rsa'
acolytec3 Jan 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Expand Up @@ -70,7 +70,7 @@ The public key is a base64 encoded string of a protobuf containing an RSA DER bu
```JavaScript
const PeerId = require('peer-id')

const id = await PeerId.create({ bits: 1024, keyType: 'rsa' })
const id = await PeerId.create({ bits: 1024, keyType: 'RSA' })
console.log(JSON.stringify(id.toJSON(), null, 2))
```

Expand Down Expand Up @@ -149,7 +149,7 @@ The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2
Generates a new Peer ID, complete with public/private keypair.

- `opts.bits: number` - The size of the key. Default: `2048`
- `opts.keyType: string` - The key type, one of: `['rsa', 'ed25519', 'secp256k1']`. Default: `rsa`
- `opts.keyType: string` - The key type, one of: `['RSA', 'ed25519', 'secp256k1']`. Default: `rsa`
acolytec3 marked this conversation as resolved.
Show resolved Hide resolved

Returns `Promise<PeerId>`.

Expand Down