libsodium/README.markdown

[![Build Status](https://travis-ci.org/jedisct1/libsodium.svg?branch=master)](https://travis-ci.org/jedisct1/libsodium?branch=master)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/2397/badge.svg)](https://scan.coverity.com/projects/2397)

![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 and Android.

## Documentation

The documentation is a work-in-progress, and is being written using
Gitbook:

[libsodium documentation](https://download.libsodium.org/doc/)

## 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`.

## License

[ISC license](https://en.wikipedia.org/wiki/ISC_license).
README: Use the svg Travis image 2015-11-18 16:55:40 -05:00			`[![Build Status](https://travis-ci.org/jedisct1/libsodium.svg?branch=master)](https://travis-ci.org/jedisct1/libsodium?branch=master)`
Add Coverity Scan status 2014-06-28 21:48:53 -04:00			`[![Coverity Scan Build Status](https://scan.coverity.com/projects/2397/badge.svg)](https://scan.coverity.com/projects/2397)`
Add Travis build status 2013-04-26 02:43:19 -04:00
Fix logo URL 2013-01-31 02:25:02 -05:00			`![libsodium](https://raw.github.com/jedisct1/libsodium/master/logo.png)`
Logo 2013-01-31 02:16:54 -05:00			`============`
Add a few words to the documentation 2013-01-20 03:03:34 -05:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-29 01:49:18 -04: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 03:03:34 -05:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-29 01:49:18 -04: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 19:56:17 -05:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-29 01:49:18 -04:00			`Its goal is to provide all of the core operations needed to build`
			`higher-level cryptographic tools.`
More blurb 2013-01-20 19:56:17 -05:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-29 01:49:18 -04:00			`Sodium supports a variety of compilers and operating systems,`
Mention that Win64 is supported. 2013-10-22 01:25:33 -04:00			`including Windows (with MingW or Visual Studio, x86 and x64), iOS and Android.`
More blurb 2013-01-20 19:56:17 -05:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-29 01:49:18 -04:00			`## Documentation`
Document sodium_mlock()/sodium_munlock() 2014-05-08 17:19:46 -04:00
Deprecate the single-file documentation, link to the gitbook one 2014-06-29 01:49:18 -04:00			`The documentation is a work-in-progress, and is being written using`
			`Gitbook:`
Document sodium_mlock()/sodium_munlock() 2014-05-08 17:19:46 -04:00
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-08 00:53:59 -04:00			`[libsodium documentation](https://download.libsodium.org/doc/)`
Add a reference to the COPYING files in README.markdown 2013-07-29 12:37:42 -04:00
Re-add the address of the mailing list 2014-06-29 01:50:51 -04:00			`## Community`

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

Add backquotes 2014-06-29 01:51:39 -04: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-29 01:50:51 -04:00
Add a reference to the COPYING files in README.markdown 2013-07-29 12:37:42 -04: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-08 00:53:59 -04:00			`[ISC license](https://en.wikipedia.org/wiki/ISC_license).`