Skip to content

Commit

Permalink
Added reference to API documentation below Cipher sample in README
Browse files Browse the repository at this point in the history
  • Loading branch information
michiels committed Sep 17, 2013
1 parent 399b977 commit a76f759
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ socket.close
ssl.close
```

### Encrypting data
### Encrypting or decrypting data

The `PolarSSL::Cipher` class lets you encrypt data with a wide range of
encryption standards like AES, Blowfish and DES.
Expand All @@ -76,6 +76,9 @@ encrypted_data = cipher.finish
encoded_encrypted_data = Base64.encode64(encrypted_data)
```

See the documentation for the `Cipher` class in the [API documentation](http://michiels.github.io/polarssl-ruby/doc)
for all the available options.

## Contributing

Install PolarSSL from source via https://polarssl.org/download or install it using your operating system. For example:
Expand Down

0 comments on commit a76f759

Please sign in to comment.