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