Documenation added

[lloc]

• AGENTS.md added
• Added documentation to the existing README.md
• Build adjusted accordingly

[gemini-code-assist]

Summary of Changes

Hello @lloc, 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 enhancing the project's documentation and refining its build process. It introduces a dedicated file for developer guidelines and significantly improves the main README for better user and contributor onboarding. The build configuration is also refined to ensure cleaner release packages by excluding development dependencies.

Highlights

• New Documentation File: Introduced a new AGENTS.md file that outlines comprehensive repository guidelines, including project structure, build commands, coding style, testing, commit/PR guidelines, and release packaging.
• Updated README: The README.md has been significantly expanded to provide clearer installation, usage, development, and contribution instructions, with a direct reference to the new AGENTS.md for detailed guidelines.
• Build Process Enhancement: The composer.json build script was updated to include composer update --no-dev, ensuring that development dependencies are not bundled in the final release package.
• Ignored Files Updates: Both .distignore and .gitignore files were updated to correctly exclude .phpcs.cache from distribution and version control, and AGENTS.md was added to .distignore.

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

The pull request adds documentation and adjusts the build process. It introduces an AGENTS.md file with repository guidelines, updates the README.md to include installation, usage, development, and contribution information, modifies .distignore and .gitignore to include .phpcs.cache, and updates composer.json to include @composer update --no-dev in the build script. I have provided feedback to address a potential issue in the composer.json file.