Skip to content

Commit 1cd695b

Browse files
committed
Updated readme
1 parent 680f381 commit 1cd695b

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Node-RSA
22

3-
Node.js RSA library
3+
Node.js RSA library
44
Based on jsbn library from Tom Wu http://www-cs-students.stanford.edu/~tjw/jsbn/
55

66
* Pure JavaScript
@@ -59,7 +59,7 @@ key.loadFromPEM(pem_string);
5959
key.toPrivatePEM();
6060
key.toPublicPEM([strict]);
6161
```
62-
* **strict** - if true method will return false if key pair have private exponent. Default *false*.
62+
**strict** - if true method will return false if key pair have private exponent. Default *false*.
6363

6464
### Test key
6565
```js
@@ -71,9 +71,9 @@ key.isPublic();
7171
```js
7272
key.encrypt(buffer, [source_encoding], [output_encoding]);
7373
```
74-
* **buffer** - data for encrypting, may be string, Buffer, or any object/array. Arrays and objects will encoded to JSON string first.
75-
* **source_encoding** - source encoding, works only with string buffer. Can take standard Node.js Buffer encodings (hex, utf8, base64, etc). *Utf8* by default.
76-
* **output_encoding** - encoding for output result, can also take 'buffer' to return Buffer object. Default *base64*.
74+
**buffer** - data for encrypting, may be string, Buffer, or any object/array. Arrays and objects will encoded to JSON string first.
75+
**source_encoding** - source encoding, works only with string buffer. Can take standard Node.js Buffer encodings (hex, utf8, base64, etc). *Utf8* by default.
76+
**output_encoding** - encoding for output result, can also take 'buffer' to return Buffer object. Default *base64*.
7777

7878
```js
7979
key.decrypt(buffer, [encoding]);
@@ -89,15 +89,14 @@ Questions, comments, bug reports, and pull requests are all welcome.
8989

9090
## License for NodeRSA.js
9191

92-
Copyright (c) 2014 rzcoder
93-
92+
Copyright (c) 2014 rzcoder
9493
All Rights Reserved.
9594

9695
BSD
9796

9897
## Licensing for code used in rsa.js and jsbn.js
9998

100-
Copyright (c) 2003-2005 Tom Wu
99+
Copyright (c) 2003-2005 Tom Wu
101100
All Rights Reserved.
102101

103102
Permission is hereby granted, free of charge, to any person obtaining
@@ -123,4 +122,4 @@ OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
123122
In addition, the following condition applies:
124123

125124
All redistributions must retain an intact copy of this copyright notice
126-
and disclaimer.
125+
and disclaimer.

0 commit comments

Comments
 (0)