Home | History | Annotate | Line # | Download | only in dist
README.markdown revision 1.1 
      1  1.1  riastrad [![Build Status](https://travis-ci.org/jedisct1/libsodium.svg?branch=master)](https://travis-ci.org/jedisct1/libsodium?branch=master)
      2  1.1  riastrad [![Windows build status](https://ci.appveyor.com/api/projects/status/fu8s2elx25il98hj?svg=true)](https://ci.appveyor.com/project/jedisct1/libsodium)
      3  1.1  riastrad [![Coverity Scan Build Status](https://scan.coverity.com/projects/2397/badge.svg)](https://scan.coverity.com/projects/2397)
      4  1.1  riastrad 
      5  1.1  riastrad ![libsodium](https://raw.github.com/jedisct1/libsodium/master/logo.png)
      6  1.1  riastrad ============
      7  1.1  riastrad 
      8  1.1  riastrad Sodium is a new, easy-to-use software library for encryption,
      9  1.1  riastrad decryption, signatures, password hashing and more.
     10  1.1  riastrad 
     11  1.1  riastrad It is a portable, cross-compilable, installable, packageable
     12  1.1  riastrad fork of [NaCl](http://nacl.cr.yp.to/), with a compatible API, and an
     13  1.1  riastrad extended API to improve usability even further.
     14  1.1  riastrad 
     15  1.1  riastrad Its goal is to provide all of the core operations needed to build
     16  1.1  riastrad higher-level cryptographic tools.
     17  1.1  riastrad 
     18  1.1  riastrad Sodium supports a variety of compilers and operating systems,
     19  1.1  riastrad including Windows (with MingW or Visual Studio, x86 and x64), iOS, Android,
     20  1.1  riastrad as well as Javascript and Webassembly.
     21  1.1  riastrad 
     22  1.1  riastrad ## Documentation
     23  1.1  riastrad 
     24  1.1  riastrad The documentation is available on Gitbook:
     25  1.1  riastrad 
     26  1.1  riastrad * [libsodium documentation](https://download.libsodium.org/doc/) -
     27  1.1  riastrad online, requires Javascript.
     28  1.1  riastrad * [offline documentation](https://www.gitbook.com/book/jedisct1/libsodium/details)
     29  1.1  riastrad in PDF, MOBI and ePUB formats.
     30  1.1  riastrad 
     31  1.1  riastrad ## Integrity Checking
     32  1.1  riastrad 
     33  1.1  riastrad The integrity checking instructions (including the signing key for libsodium)
     34  1.1  riastrad are available in the [installation](https://download.libsodium.org/doc/installation/index.html#integrity-checking)
     35  1.1  riastrad section of the documentation.
     36  1.1  riastrad 
     37  1.1  riastrad ## Community
     38  1.1  riastrad 
     39  1.1  riastrad A mailing-list is available to discuss libsodium.
     40  1.1  riastrad 
     41  1.1  riastrad In order to join, just send a random mail to `sodium-subscribe` {at}
     42  1.1  riastrad `pureftpd` {dot} `org`.
     43  1.1  riastrad 
     44  1.1  riastrad ## License
     45  1.1  riastrad 
     46  1.1  riastrad [ISC license](https://en.wikipedia.org/wiki/ISC_license).
     47