diff --git a/README.markdown b/README.markdown index 00805dd2..b7d70080 100644 --- a/README.markdown +++ b/README.markdown @@ -1,66 +1,77 @@ -[![GitHub CI](https://github.com/jedisct1/libsodium/workflows/CI/badge.svg)](https://github.com/jedisct1/libsodium/actions) -[![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) -[![CodeQL scan](https://github.com/jedisct1/libsodium/workflows/CodeQL%20scan/badge.svg)](https://github.com/jedisct1/libsodium/actions) +# libsodium + +[![GitHub CI](https://github.com/jedisct1/libsodium/workflows/CI/badge.svg)](https://github.com/jedisct1/libsodium/actions) +[![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) +[![CodeQL Scan](https://github.com/jedisct1/libsodium/workflows/CodeQL%20scan/badge.svg)](https://github.com/jedisct1/libsodium/actions) ![libsodium](https://raw.github.com/jedisct1/libsodium/master/logo.png) -============ -Sodium is an easy-to-use software library for encryption, -decryption, signatures, password hashing, and more. +Sodium is an easy-to-use software library that provides a wide range of cryptographic operations including encryption, decryption, digital signatures, and secure password hashing. It is a portable, cross-compilable, installable, and packageable fork of [NaCl](http://nacl.cr.yp.to/). While maintaining API compatibility, libsodium extends functionality to improve usability and simplify the development of secure applications. -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. +## Key Features -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. +- **Encryption & Decryption:** Securely encrypt and decrypt data with modern algorithms. +- **Digital Signatures:** Create and verify signatures to ensure data authenticity. +- **Password Hashing:** Safeguard credentials with robust password hashing techniques. +- **Cross-Platform Compatibility:** Supported on Windows (MinGW and Visual Studio, both x86 and x64), iOS, Android, JavaScript, and WebAssembly. +- **User-Friendly API:** Designed to provide all core cryptographic operations while remaining easy to integrate into your projects. + +--- ## Documentation -The documentation is available on Gitbook and built from the -[libsodium-doc](https://github.com/jedisct1/libsodium-doc) repository: +Detailed documentation is available online. It is generated from the [libsodium-doc](https://github.com/jedisct1/libsodium-doc) repository and requires JavaScript for full functionality: -* [libsodium documentation](https://doc.libsodium.org) - online, requires Javascript. +- [libsodium Documentation](https://doc.libsodium.org) + +--- ## 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. +For security and authenticity, please review the integrity checking instructions. These include the signing keys and methods to verify your installation: -## Community +- [Integrity Checking Instructions](https://download.libsodium.org/doc/installation#integrity-checking) -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](https://github.com/jedisct1/libsodium/graphs/contributors)]. +This project thrives thanks to the valuable contributions from our community. View all the [contributors](https://github.com/jedisct1/libsodium/graphs/contributors): - + + Contributors + ### Financial Contributors -Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/libsodium/contribute)] +Your financial support helps us sustain and further develop libsodium. -#### Individuals +- [Become a Financial Contributor](https://opencollective.com/libsodium/contribute) + +#### Individuals + + + Individual Contributors + #### 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)] +Support libsodium with your organization and gain visibility through your logo and website link. - +- [Support with Your Organization](https://opencollective.com/libsodium/contribute) + + + Organization Contributor + + +--- ## License -[ISC license](https://en.wikipedia.org/wiki/ISC_license). +This project is distributed under the [ISC license](https://en.wikipedia.org/wiki/ISC_license).