docs: overhaul README and CLI help with comprehensive feature documentation

[stevehansen]

• Rewrite README with full CLI reference table, feature details for
  column stripping, join stripping, aggressive mode, and join hints
  (including safety matrix), re-inlining support, output format, and
  library usage examples with InlinerOptions API
• Add Library NuGet installation section and programmatic API examples
• Improve CLI --help output: descriptive option text, usage examples,
  join hint syntax, and a pointer to SqlInliner.Library NuGet package

https://claude.ai/code/session_01RtJtCDtKnm8VE7NwoAy2Fe

[gemini-code-assist]

Summary of Changes

Hello @stevehansen, 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 significantly enhances the project's documentation and user experience by providing a thoroughly updated README and more informative CLI help. The changes aim to make the sql-inliner tool and library easier to understand and use, covering its core functionalities, advanced features, and integration options in much greater detail. This will empower users to leverage the view optimization capabilities more effectively and confidently.

Highlights

• Comprehensive README Overhaul: The README has been completely rewritten to include a full CLI reference table, detailed explanations of features like column stripping, join stripping, aggressive mode, join hints (including a safety matrix), re-inlining support, and output format. It also now provides extensive library usage examples with the InlinerOptions API.
• NuGet Library Documentation: A new section has been added to the README detailing NuGet package installation for the SqlInliner.Library and providing programmatic API examples for integrating the inlining engine into custom applications or build pipelines.
• Enhanced CLI Help Output: The command-line interface's --help output has been significantly improved with more descriptive option text, practical usage examples, clear explanation of join hint syntax, and a pointer to the SqlInliner.Library NuGet package for programmatic use.

Changelog

• README.md
  • Rewrote the introductory description of the tool.
  • Expanded the 'Why use sql-inliner?' section with detailed benefits.
  • Added a dedicated 'Library (NuGet)' installation guide.
  • Introduced a comprehensive 'CLI reference' table with all options and descriptions.
  • Provided more diverse and detailed 'Examples' for CLI usage.
  • Added new 'Feature details' sections covering column stripping, join stripping, aggressive join stripping, join hints (with syntax and safety matrix), re-inlining support, and output format.
  • Updated the 'Verifying the generated code' section with clearer SQL examples.
  • Included a new 'Library usage' section with C# code examples for programmatic integration.
  • Minor updates to 'Security considerations' and added a 'License' section.
• src/SqlInliner/Program.cs
  • Updated the Description property for all command-line options to be more informative.
  • Added a detailed, multi-line description for the RootCommand that includes an overview, requirements, usage examples, join hint syntax, and NuGet package information.
  • Removed a TODO comment related to DatabaseView.parser.

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 provides a significant overhaul of the project's documentation, including a comprehensive rewrite of the README.md file and improvements to the CLI's help output. The new README is well-structured, detailed, and includes valuable information on installation, CLI usage, feature details, and library integration. The CLI help text is also much more informative.

I've found one issue in a C# code example in the README that would cause it to fail at runtime. My feedback includes a correction for this example to ensure users of the library have a smooth experience.