<commit_before># README

brew install libsodium<commit_msg>Inclusion of a better description on README<commit_after># kalium - Java binding to the Networking and Cryptography (NaCl) library 

A Java binding to [Networking and Cryptography](http://nacl.cr.yp.to/) library by [<NAME>](http://cr.yp.to/djb.html). All the hard work of making a portable NaCl API version was done by [<NAME>](https://github.com/jedisct1) on [libsodium](https://github.com/jedisct1/libsodium) and kalium was totally inspired by [Tony Arcieri's](https://github.com/tarcieri) work with [RbNaCl](https://github.com/cryptosphere/rbnacl).   

## Requirements

* JDK 6 or [higher](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* [Apache Maven](http://maven.apache.org/guides/getting-started/)

## Installation

### libsodium

kalium is implemented using [jnr-ffi](https://github.com/jnr/jnr-ffi) to bind the shared libraries from [libsodium](https://github.com/jedisct1/libsodium). For a more detailed explanation, please refer to [RbNaCl's documentation](https://github.com/cryptosphere/rbnacl/blob/master/README.md).

OS X users can get libsodium via [homebrew](http://mxcl.github.com/homebrew/) with: 

    brew install libsodium 

### kalium installation

    git clone https://github.com/abstractj/kalium && cd kalium
    mvn clean install
    
Add as a Maven dependency at your project:

    <dependency>
        <groupId>org.abstractj.kalium</groupId>
        <artifactId>kalium</artifactId>
        <version>0.1.0-SNAPSHOT</version>
        <scope>compile</scope>
    </dependency>
        
    
### Notes

kalium is a work in progress, feedback, bug reports and patches are always welcome.



 
{'fraction_non_alphanumeric': 0.1267688679245283, 'fraction_numerical': 0.004127358490566038, 'mean_word_length': 3.9765395894428153, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 8, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4450596', 'n_tokens_mistral': 580, 'n_tokens_neox': 529, 'n_words': 141}