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