libsodium/README.markdown

[![Build Status](https://travis-ci.org/jedisct1/libsodium.svg?branch=master)](https://travis-ci.org/jedisct1/libsodium?branch=master)
[![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)
[![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)

![libsodium](https://raw.github.com/jedisct1/libsodium/master/logo.png)
============

Sodium is a new, easy-to-use software library for encryption,
decryption, signatures, password hashing and more.

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.

Its goal is to provide all of the core operations needed to build
higher-level cryptographic tools.

Sodium supports a variety of compilers and operating systems,
including Windows (with MingW or Visual Studio, x86 and x64), iOS, Android,
as well as Javascript and Webassembly.

## Documentation

The documentation is available on Gitbook and built from the [libsodium-doc](https://github.com/jedisct1/libsodium-doc) repository:

* [libsodium documentation](https://download.libsodium.org/doc/) -
online, requires Javascript.
* [offline documentation](https://www.gitbook.com/book/jedisct1/libsodium/details)
in PDF format.

## Integrity Checking

The integrity checking instructions (including the signing key for libsodium)
are available in the [installation](https://download.libsodium.org/doc/installation#integrity-checking)
section of the documentation.

## Community

A mailing-list is available to discuss libsodium.

In order to join, just send a random mail to `sodium-subscribe` {at}
`pureftpd` {dot} `org`.

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

<a href="https://github.com/jedisct1/libsodium/graphs/contributors"><img src="https://opencollective.com/libsodium/contributors.svg?width=890&button=false" /></a>

### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/libsodium/contribute)]

#### Individuals

<a href="https://opencollective.com/libsodium"><img src="https://opencollective.com/libsodium/individuals.svg?width=890"></a>

#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/libsodium/contribute)]

<a href="https://opencollective.com/libsodium/organization/0/website"><img src="https://opencollective.com/libsodium/organization/0/avatar.svg"></a>


## License

[ISC license](https://en.wikipedia.org/wiki/ISC_license).
README: Use the svg Travis image 2015-11-18 14:55:40 -07:00			`[![Build Status](https://travis-ci.org/jedisct1/libsodium.svg?branch=master)](https://travis-ci.org/jedisct1/libsodium?branch=master)`
Add Appveyor status 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)`
Revert "Coverity Scan is having hosting issues" This reverts commit c999d07255f3085f2190e8eb2cf6c1e249477b12. 2019-01-30 10:45:53 -07:00			`[![Coverity Scan Build Status](https://scan.coverity.com/projects/2397/badge.svg)](https://scan.coverity.com/projects/2397)`
Update status badge 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)`
Add Travis build status 2013-04-25 23:43:19 -07:00
Fix logo URL 2013-01-31 00:25:02 -07:00			`![libsodium](https://raw.github.com/jedisct1/libsodium/master/logo.png)`
Logo 2013-01-31 00:16:54 -07:00			`============`
Add a few words to the documentation 2013-01-20 01:03:34 -07:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-28 22:49:18 -07:00			`Sodium is a new, easy-to-use software library for encryption,`
			`decryption, signatures, password hashing and more.`
Add a few words to the documentation 2013-01-20 01:03:34 -07:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-28 22:49:18 -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.`
More blurb 2013-01-20 17:56:17 -07:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-28 22:49:18 -07:00			`Its goal is to provide all of the core operations needed to build`
			`higher-level cryptographic tools.`
More blurb 2013-01-20 17:56:17 -07:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-28 22:49:18 -07:00			`Sodium supports a variety of compilers and operating systems,`
Add js & wasm to the list 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.`
More blurb 2013-01-20 17:56:17 -07:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-28 22:49:18 -07:00			`## Documentation`
Document sodium_mlock()/sodium_munlock() 2014-05-08 14:19:46 -07:00
README: link to libsodium-doc repository 2018-02-07 09:47:03 -07:00			`The documentation is available on Gitbook and built from the [libsodium-doc](https://github.com/jedisct1/libsodium-doc) repository:`
Document sodium_mlock()/sodium_munlock() 2014-05-08 14:19:46 -07:00
Mention that the gitbook online documentation requires Javascript Add a link to the offline documentation 2015-12-23 19:39:41 -07:00			`* [libsodium documentation](https://download.libsodium.org/doc/) -`
			`online, requires Javascript.`
			`* [offline documentation](https://www.gitbook.com/book/jedisct1/libsodium/details)`
Offline documentation is only available in PDF format now 2019-01-06 07:55:36 -07:00			`in PDF format.`
Add a reference to the COPYING files in README.markdown 2013-07-29 09:37:42 -07:00
Make it easier to find the integrity checking instructions https://twitter.com/DefuseSec/status/710589949511241728 cc @defuse 2016-03-17 15:20:59 -07:00			`## Integrity Checking`

Mention which section + split line 2016-03-17 15:26:02 -07:00			`The integrity checking instructions (including the signing key for libsodium)`
Fix broken link to documentation in README 2018-11-06 09:40:11 -07:00			`are available in the [installation](https://download.libsodium.org/doc/installation#integrity-checking)`
Link text = "installation" only 2016-03-17 15:27:08 -07:00			`section of the documentation.`
Make it easier to find the integrity checking instructions https://twitter.com/DefuseSec/status/710589949511241728 cc @defuse 2016-03-17 15:20:59 -07:00
Re-add the address of the mailing list 2014-06-28 22:50:51 -07:00			`## Community`

			`A mailing-list is available to discuss libsodium.`

Add backquotes 2014-06-28 22:51:39 -07:00			In order to join, just send a random mail to `sodium-subscribe` {at}
			`pureftpd` {dot} `org`.
Re-add the address of the mailing list 2014-06-28 22:50:51 -07:00
Add Open Collective contributors to readme 2019-07-15 06:46:53 -07:00			`## Contributors`

			`### Code Contributors`

			`This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].`

			`<a href="https://github.com/jedisct1/libsodium/graphs/contributors"><img src="https://opencollective.com/libsodium/contributors.svg?width=890&button=false" /></a>`

			`### Financial Contributors`

			`Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/libsodium/contribute)]`

			`#### Individuals`

			`<a href="https://opencollective.com/libsodium"><img src="https://opencollective.com/libsodium/individuals.svg?width=890"></a>`

			`#### Organizations`

			`Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/libsodium/contribute)]`

			`<a href="https://opencollective.com/libsodium/organization/0/website"><img src="https://opencollective.com/libsodium/organization/0/avatar.svg"></a>`



Add a reference to the COPYING files in README.markdown 2013-07-29 09:37:42 -07:00			`## License`

Use https when linking where possible. Only makes sense to use TLS when linking from a crypto-related library. Had to change the libsodium documentation link a bit because the original URL returns the gitbook.org certificate. cr.yp.to doesn't actually support encrypting HTTP with TLS so we leave it as-is. 2015-05-07 21:53:59 -07:00			`[ISC license](https://en.wikipedia.org/wiki/ISC_license).`