Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mvhenten authored May 14, 2024
1 parent 79be29b commit 7a8d1b7
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,18 @@ sized alphabet based on the actual contents of the string.

![image of the formula for information entropy calculation](https://upload.wikimedia.org/math/6/2/7/6270d629826e5df0949332423566dd78.png)

### Demo

A [simple password strength meter](https://mvhenten.github.io/string-entropy/) that updates as you type.

### Documentation

See the annotated sources [src/index.ts](src/index.ts).

### Example

```javascript
var entropy = require('string-entropy');
const { entropy } = require('string-entropy');

console.log(entropy('correct horse battery staple'));
// outputs 132
Expand Down

0 comments on commit 7a8d1b7

Please sign in to comment.