docs: update README.md

[chenjiahan]

Updates the README.md to modernize and simplify the installation instructions for various package managers, clarify configuration usage, and improve clarity in the API usage section.

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

[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 clarity and accuracy of the project's documentation. It modernizes installation instructions, refines configuration examples, and updates API usage guidelines, ensuring that users have the most current and straightforward information for setting up and utilizing the project.

Highlights

• Installation Command Modernization: Updated installation commands for npm, yarn, pnpm, and bun to use the shorthand -D flag for devDependencies, simplifying the instructions.
• Configuration Example Refinement: Simplified the rspack.config.mjs example by removing an unnecessary comment and clarifying the devServer configuration structure.
• API Usage Clarity: Improved the API usage example by changing the rspack import to a named export and renaming the configuration variable for better readability.
• Documentation Link Update: Corrected and updated the link to the devServer configuration documentation for Rspack.
• Removed Outdated Information: Eliminated a note referencing webpack-dev-server@5 API, streamlining the documentation to be more focused on Rspack.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• README.md
  • Updated package installation commands to use -D instead of --save-dev or --dev.
  • Removed a redundant comment from the rspack.config.mjs example.
  • Modified the API usage example to import rspack as a named export and renamed the config variable.
  • Updated the link to the devServer configuration documentation.
  • Removed a note about webpack-dev-server@5.

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 effectively updates the README.md to modernize and simplify the installation instructions, clarify configuration usage, and improve the API usage section. The changes, such as replacing --save-dev with -D for package installations and updating the rspack import to a named import, align well with the stated goals of the pull request.

_{Note: Security Review has been skipped due to the limited scope of the PR.}

[Copilot]

Pull request overview

Updates README.md to streamline installation instructions across package managers and refresh the configuration/API usage examples to be more consistent with current @rspack/* usage.

Changes:

• Simplifies install commands by using the -D shorthand for dev dependencies across npm/yarn/pnpm/bun.
• Updates the API usage snippet to use import { rspack } from '@rspack/core' and a simpler config variable name.
• Tweaks documentation links/text and removes an outdated note about the underlying webpack-dev-server API.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.