Skip to content

Commit

Permalink
Fix doc before initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
kraynel committed Jul 5, 2016
1 parent 0a054e5 commit becc84b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@

[![CircleCI](https://circleci.com/gh/kraynel/js-rijndael.svg?style=svg)](https://circleci.com/gh/kraynel/js-rijndael)
[![Coverage Status](https://coveralls.io/repos/github/kraynel/js-rijndael/badge.svg?branch=master)](https://coveralls.io/github/kraynel/js-rijndael?branch=master)
[![Known Vulnerabilities](https://snyk.io/test/npm/js-rijndael/badge.svg)](https://snyk.io/test/npm/js-rijndael)

JS-Rijndael is a port of F. Doering and B. Poettering implementation of Rijndael algorithm.
It has no external dependencies and is fully compatible with [mcrypt](http://php.net/manual/fr/book.mcrypt.php).

## How to use

Add the dependency to your project: `npm install --save js-mcrypt`.
Add the dependency to your project: `npm install --save js-rijndael`.
Require it in your file.
```js
var mcrypt = require('js-mcrypt');
var mcrypt = require('js-rijndael');
```
`mcrypt.listAlgorithms()` lists the available ciphers:
- rijndael-128
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "js-rijndael",
"version": "0.1.0",
"version": "1.0.0",
"description": "Javascript implementation of the rijndael block cipher. Key lengths of 128, 192 and 256 bits, and block lengths of 128, 192, and 256 bit in any combination are supported.",
"main": "mcrypt.js",
"scripts": {
Expand Down

0 comments on commit becc84b

Please sign in to comment.