README Enhancement: Improved Clarity and Usability

[mariajaureguiim]

This pull request enhances the README file to provide users with clearer and more comprehensive information about the Cupcake Rust library. The changes aim to improve the overall user experience by offering step-by-step installation instructions, highlighting the importance of benchmarks and tests, and providing essential details about supported parameters. Here's a summary of the key improvements:

Title and Description: The README now includes a concise title and a more descriptive introduction to the library, making it easier for users to understand its purpose and capabilities.

Table of Contents: We've added a structured table of contents to facilitate easy navigation through the README.

Requirements: Compatible platforms are explicitly listed, helping users quickly determine if Cupcake suits their environment.

Installation: We've provided clear, step-by-step installation instructions, including how to install Rust and create a new Rust project if needed. We've emphasized the importance of adding Cupcake as a dependency in the Cargo.toml file.

Benchmarks and Tests: We've explained the significance of benchmarks and tests and provided commands for running them. This helps users ensure the reliability and performance of the library.

Supported Parameters: Information about the default secure parameter set is provided, along with an emphasis on the importance of caution when changing parameters. This section helps users understand the implications of parameter choices.

These improvements aim to make the README more user-friendly and informative, ultimately enhancing the user experience for individuals interested in utilizing the Cupcake library for their cryptographic needs.

[facebook-github-bot]

Hi @mariajaureguiim!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[haochenuw]

thanks for contributing! I can approve once you have signed the CLA.