README.markdown
1[](https://travis-ci.org/jedisct1/libsodium?branch=master)
2[](https://ci.appveyor.com/project/jedisct1/libsodium)
3[](https://scan.coverity.com/projects/2397)
4
5
6============
7
8Sodium is a new, easy-to-use software library for encryption,
9decryption, signatures, password hashing and more.
10
11It is a portable, cross-compilable, installable, packageable
12fork of [NaCl](http://nacl.cr.yp.to/), with a compatible API, and an
13extended API to improve usability even further.
14
15Its goal is to provide all of the core operations needed to build
16higher-level cryptographic tools.
17
18Sodium supports a variety of compilers and operating systems,
19including Windows (with MingW or Visual Studio, x86 and x64), iOS, Android,
20as well as Javascript and Webassembly.
21
22## Documentation
23
24The 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/) -
27online, requires Javascript.
28* [offline documentation](https://www.gitbook.com/book/jedisct1/libsodium/details)
29in PDF, MOBI and ePUB formats.
30
31## Integrity Checking
32
33The integrity checking instructions (including the signing key for libsodium)
34are available in the [installation](https://download.libsodium.org/doc/installation/index.html#integrity-checking)
35section of the documentation.
36
37## Community
38
39A mailing-list is available to discuss libsodium.
40
41In 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).
47
