sys/contrib/libsodium/README.markdown

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