Skip to content

Commit 936058b

Browse files
committed
Doc: update readme to reflect NPM publication
1 parent 5f1a7ac commit 936058b

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,22 @@ A JavaScript implementation of the JSON Object Signing and Encryption (JOSE) for
3030

3131
## Installing ##
3232

33-
To install the latest from the repository:
33+
To install the latest from [NPM](https://npmjs.com/):
3434

3535
```
36-
npm install git+ssh://[email protected]:cisco/node-jose.git
36+
npm install node-jose
3737
```
3838

39-
Or to install a specific release from the repository:
39+
Or to install a specific release:
4040

4141
```
42-
npm install git+ssh://[email protected]:cisco/node-jose.git#0.3.0
42+
npm install [email protected]
43+
```
44+
45+
Alternatively, the latest unpublished code can be installed directly from the repository:
46+
47+
```
48+
npm install git+ssh://[email protected]:cisco/node-jose.git
4349
```
4450

4551
## Basics ##
@@ -52,6 +58,8 @@ var jose = require('node-jose');
5258

5359
This library uses [Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) for nearly every operation.
5460

61+
This library supports [Browserify](http://browserify.org/). To use in a web browser, `require('node-kms')` and bundle with the rest of your app.
62+
5563
The content to be signed/encrypted or returned from being verified/decrypted are [Buffer](https://nodejs.org/api/buffer.html) objects.
5664

5765
## Keys and Key Stores ##

0 commit comments

Comments
 (0)