Update README

[cathay4t]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @cathay4t, 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 primarily focuses on improving the documentation for the nl_wireguard crate. It provides clear, runnable examples in the README for common operations like querying and setting WireGuard interface configurations, making the crate easier to understand and use. A small but important clarification regarding interface creation prerequisites has also been added to the library's internal documentation.

Highlights

• README Update: The README.md file has been significantly expanded to include practical code examples for querying and setting WireGuard configurations using the nl_wireguard crate. The 'WIP' tag has also been removed from the main title.
• Documentation Clarification: A note has been added to the src/lib.rs documentation, clarifying that the rtnetlink crate is required to create a WireGuard interface before its configuration can be set.

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. ↩

[gemini-code-assist]

Code Review

This pull request updates the README and library documentation with usage examples. My review focuses on improving the examples by demonstrating robust error handling instead of using .unwrap(), which can lead to panics. I've also pointed out a minor grammatical typo in both the README and the source code documentation. The proposed changes will make the examples safer and more instructive for users of the crate.