Skip to content

Commit a4dae38

Browse files
author
John Bland
committed
update readme to use npm install instructions
1 parent 47d1e7b commit a4dae38

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,25 +22,16 @@ Verify the .so (shared object) path and version in `binding.gyp`:
2222

2323
## Package Installation
2424

25-
Use npm to install and build:
25+
Use npm to install the package:
2626

2727
```
28-
npm i
29-
npm run build
28+
npm i wolfcrypt_binding
3029
```
3130

32-
Place the package into your projects `node_modules` folder and require it:
31+
Then require it in your application code
3332

3433
```
35-
mv wolfcrypt_nodejs my_project/node_modules
36-
...
37-
const { wolfcrypt, WolfSSLEncryptionStream } = require( 'wolfcrypt_nodejs' )
38-
```
39-
40-
Alternatively you can require the module by specifying a path to it
41-
42-
```
43-
const { wolfcrypt, WolfSSLEncryptionStream } = require( 'path-to-library/wolfcrypt_nodejs' )
34+
const { wolfcrypt, WolfSSLEncryptionStream } = require( 'wolfcrypt_binding' )
4435
```
4536

4637
Examples of how to use this library can be found in the tests directory

0 commit comments

Comments
 (0)