Skip to content

Commit c90e841

Browse files
committed
readme
1 parent e7abb55 commit c90e841

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ Also you can use next method:
9494
```javascript
9595
key.generateKeyPair([bits], [exp]);
9696
```
97-
**bits**`{int}` — key size in bits. 2048 by default.
98-
**exp**`{int}` — public exponent. 65537 by default.
97+
* **bits**`{int}` — key size in bits. 2048 by default.
98+
* **exp**`{int}` — public exponent. 65537 by default.
9999

100100
#### Load key from PEM string
101101

@@ -116,8 +116,8 @@ var key = new NodeRSA('-----BEGIN RSA PRIVATE KEY-----\n'+
116116
key.importKey(keyData, [format]);
117117
key.exportKey([format]);
118118
```
119-
**keyData**`{string|buffer}` — key in PEM string **or** Buffer contains PEM string **or** Buffer contains DER encoded data.
120-
**format**`{string}` — format id for export/import.
119+
* **keyData**`{string|buffer}` — key in PEM string **or** Buffer contains PEM string **or** Buffer contains DER encoded data.
120+
* **format**`{string}` — format id for export/import.
121121

122122
#### Format string syntax
123123
Format string composed of several parts: `scheme-[key_type]-[output_type]`
@@ -129,7 +129,7 @@ Format string composed of several parts: `scheme-[key_type]-[output_type]`
129129
* `'pem'` — Base64 encoded string with header and footer. Used by default.
130130
* `'der'` — Binary encoded key data.
131131

132-
**Notice:** For import, if *keyData* is pem string or buffer containing string, you can do not specify format, but if you provide *keyData* as DER you must specify it in format string.
132+
**Notice:** For import, if *keyData* is PEM string or buffer containing string, you can do not specify format, but if you provide *keyData* as DER you must specify it in format string.
133133

134134
**Shortcuts and examples**
135135
* `'private'` or `'pkcs1'` or `'pkcs1-private'` == `'pkcs1-private-pem'` — private key encoded in pcks1 scheme as pem string.
@@ -147,7 +147,6 @@ var publicDer = key.exportKey('pkcs8-public-der');
147147
var privateDer = key.exportKey('pkcs1-der');
148148
```
149149

150-
151150
### Properties
152151

153152
#### Key testing

src/NodeRSA.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ module.exports = (function () {
2727
var DEFAULT_EXPORT_FORMAT = 'private';
2828
var EXPORT_FORMAT_ALIASES = {
2929
'private': 'pkcs1-private-pem',
30-
'public': 'pkcs8-public-pem'
30+
'private-der': 'pkcs1-private-der',
31+
'public': 'pkcs8-public-pem',
32+
'public-der': 'pkcs8-public-der'
3133
};
3234

3335
/**

0 commit comments

Comments
 (0)