1
mirror of https://github.com/jedisct1/libsodium.git synced 2024-12-19 18:15:18 -07:00
libsodium/README.markdown

47 lines
2.1 KiB
Markdown
Raw Normal View History

2021-01-23 14:32:17 -07:00
[![GitHub CI](https://github.com/jedisct1/libsodium/workflows/CI/badge.svg)](https://github.com/jedisct1/libsodium/actions)
2016-01-11 03:20:58 -07:00
[![Windows build status](https://ci.appveyor.com/api/projects/status/fu8s2elx25il98hj?svg=true)](https://ci.appveyor.com/project/jedisct1/libsodium)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/2397/badge.svg)](https://scan.coverity.com/projects/2397)
2019-05-29 11:54:51 -07:00
[![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)
2021-01-23 14:32:17 -07:00
[![CodeQL scan](https://github.com/jedisct1/libsodium/workflows/CodeQL%20scan/badge.svg)](https://github.com/jedisct1/libsodium/actions)
2013-04-25 23:43:19 -07:00
2013-01-31 00:25:02 -07:00
![libsodium](https://raw.github.com/jedisct1/libsodium/master/logo.png)
2013-01-31 00:16:54 -07:00
============
2013-01-20 01:03:34 -07:00
Sodium is a new, easy-to-use software library for encryption,
decryption, signatures, password hashing and more.
2013-01-20 01:03:34 -07:00
It is a portable, cross-compilable, installable, packageable
fork of [NaCl](http://nacl.cr.yp.to/), with a compatible API, and an
extended API to improve usability even further.
2013-01-20 17:56:17 -07:00
Its goal is to provide all of the core operations needed to build
higher-level cryptographic tools.
2013-01-20 17:56:17 -07:00
Sodium supports a variety of compilers and operating systems,
2017-10-18 10:23:59 -07:00
including Windows (with MingW or Visual Studio, x86 and x64), iOS, Android,
as well as Javascript and Webassembly.
2013-01-20 17:56:17 -07:00
## Documentation
2022-03-29 06:39:22 -07:00
The documentation is available on Gitbook and built from the
[libsodium-doc](https://github.com/jedisct1/libsodium-doc) repository:
2022-03-29 06:39:22 -07:00
* [libsodium documentation](https://doc.libsodium.org) - online, requires Javascript.
## Integrity Checking
2016-03-17 15:26:02 -07:00
The integrity checking instructions (including the signing key for libsodium)
are available in the [installation](https://download.libsodium.org/doc/installation#integrity-checking)
2016-03-17 15:27:08 -07:00
section of the documentation.
2014-06-28 22:50:51 -07:00
## Community
A mailing-list is available to discuss libsodium.
2014-06-28 22:51:39 -07:00
In order to join, just send a random mail to `sodium-subscribe` {at}
`pureftpd` {dot} `org`.
2014-06-28 22:50:51 -07:00
## License
[ISC license](https://en.wikipedia.org/wiki/ISC_license).