Skip to content
This repository was archived by the owner on Sep 25, 2021. It is now read-only.

Commit 6323470

Browse files
committed
Docs: Update reference links and add NPM install.
1 parent e3cbc43 commit 6323470

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Contents
44

5-
- [Demo](#demo)
5+
- [Demo](https://blueimp.github.io/JavaScript-MD5/)
66
- [Description](#description)
77
- [Usage](#usage)
88
- [Client-side](#client-side)
@@ -12,20 +12,23 @@
1212
- [Tests](#tests)
1313
- [License](#license)
1414

15-
## Demo
16-
17-
[JavaScript MD5 Demo](https://blueimp.github.io/JavaScript-MD5/)
18-
1915
## Description
2016

21-
JavaScript MD5 implementation. Compatible with server-side environments like
22-
Node.js, module loaders like RequireJS, Browserify or webpack and all web
23-
browsers.
17+
JavaScript [MD5](https://en.wikipedia.org/wiki/MD5) implementation.
18+
Compatible with server-side environments like [Node.js](https://nodejs.org/),
19+
module loaders like [RequireJS](https://requirejs.org/) or
20+
[webpack](https://webpack.js.org/) and all web browsers.
2421

2522
## Usage
2623

2724
### Client-side
2825

26+
Install the **blueimp-md5** package with [NPM](https://www.npmjs.org/):
27+
28+
```sh
29+
npm install blueimp-md5
30+
```
31+
2932
Include the (minified) JavaScript [MD5](https://en.wikipedia.org/wiki/MD5)
3033
script in your HTML markup:
3134

@@ -45,10 +48,9 @@ var hash = md5('value') // "2063c1608d6e0baf80249c42e2be5804"
4548
### Server-side
4649

4750
The following is an example how to use the JavaScript MD5 module on the
48-
server-side with [Node.js](http://nodejs.org/).
51+
server-side with [Node.js](https://nodejs.org/).
4952

50-
Create a new directory and add the **md5.js** file. Or alternatively, install
51-
the **blueimp-md5** package with [npm](https://www.npmjs.org/):
53+
Install the **blueimp-md5** package with [NPM](https://www.npmjs.org/):
5254

5355
```sh
5456
npm install blueimp-md5
@@ -58,7 +60,7 @@ Add a file **server.js** with the following content:
5860

5961
```js
6062
require('http')
61-
.createServer(function(req, res) {
63+
.createServer(function (req, res) {
6264
// The md5 module exports the md5() function:
6365
var md5 = require('./md5'),
6466
// Use the following version if you installed the package with npm:
@@ -124,7 +126,7 @@ There are two different ways to run the tests:
124126
- run `npm test` in the Terminal in the root path of the repository package.
125127

126128
The first one tests the browser integration, the second one the
127-
[node.js](http://nodejs.org/) integration.
129+
[Node.js](https://nodejs.org/) integration.
128130

129131
## License
130132

0 commit comments

Comments
 (0)