docs: improve README

[Its-Just-Nans]

README preview at https://github.com/zip-rs/zip2/blob/improve-readme/README.md

fix #699

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the README.md file to improve its overall presentation, clarity, and user experience. The changes introduce prominent project badges, restructure the document with more appropriate heading levels, standardize list formatting, and provide direct links to example code, making it easier for users to navigate and understand the project's features and usage at a glance.

Highlights

• README Header Enhancement: The main header of the README has been updated to include various project badges, such as crates.io version, download count, docs.rs link, build status, and OpenSSF Best Practices, providing a quick overview of the project's health and status.
• Structural Reorganization: Section headings have been demoted from top-level (#) to sub-level (##) for improved document structure and readability, making it easier to navigate through different topics.
• Formatting Consistency: All bulleted lists throughout the document have been standardized to use hyphens (-) instead of asterisks (*), contributing to a more consistent and cleaner visual presentation.
• Improved Examples Section: The examples section now includes direct links to the relevant example files within the repository, allowing users to quickly access and understand how to use different features.
• Code Block Syntax Standardization: Shell command blocks have been updated to use sh for syntax highlighting instead of bash, promoting broader compatibility and general shell usage.

Changelog

• README.md
  • Updated the main title to include project badges for crates.io, downloads, docs.rs, build status, and OpenSSF.
  • Changed the 'Info' section to a direct description and updated the hosting link from 'Formerly hosted at' to 'Currently hosted at'.
  • Converted all bulleted lists from * to - for consistency.
  • Demoted top-level headings (# Info, # Features, # MSRV, # Examples, # Fuzzing) to sub-headings (## Features, ## MSRV, ## Examples, ## Fuzzing).
  • Added direct file links to the examples section.
  • Replaced bash syntax highlighting with sh in code blocks.

Activity

• No specific activity (comments, reviews, or progress updates) has been recorded for this pull request.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[amazon-q-developer]

This PR improves the README documentation with better formatting and clearer structure. The changes include:

• Modernized header with badges consolidated on one line
• Updated repository status from "Formerly hosted" to "Currently hosted"
• Consistent markdown formatting (bullet points, section headers)
• Added direct links to example files for easier navigation
• Standardized code block language tags to sh
• Improved readability with additional blank lines

All changes are documentation improvements with no functional code modifications. No blocking issues identified.

---

You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

[gemini-code-assist]

Code Review

This pull request significantly improves the README.md file by restructuring headings, adding more informative badges, and providing direct links to code examples. These changes enhance readability and user experience. I have a couple of suggestions to fix a broken link and make one of the new badges clickable for easier navigation.