Add configuration section to README

[alistair3149]

Follow up to the config added in #37

Summary by CodeRabbit

• Documentation
  • Expanded the documentation with a new PHP configuration section.
  • The updated guide provides clear instructions and examples on setting up the extension to integrate with an external image service.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the README.md file by adding a new "PHP Configuration" section. The section explains how to configure the extension via LocalSettings.php and includes a subheading titled "Setting foreign file repo." The documentation introduces an optional variable, $wgWikibaseLocalMediaRemoteApiUrl, which is used with $wgForeignFileRepos for retrieving images from any wiki. The variable is detailed with a default value of null and an example URL: https://commons.wikimedia.org/w/api.php.

Changes

Files	Change Summaries
README.md	Added "PHP Configuration" section with subheading "Setting foreign file repo." Introduced and documented the $wgWikibaseLocalMediaRemoteApiUrl variable, its default value (null), and an example URL (https://commons.wikimedia.org/w/api.php).

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

61-67: Enhance Configuration Documentation

The new "PHP Configuration" section is a clear and useful addition. It explains how to change configuration via LocalSettings.php and documents the newly introduced variable $wgWikibaseLocalMediaRemoteApiUrl with its default value and an example URL. This will help users understand how to integrate this configuration with $wgForeignFileRepos.

Consider rephrasing the phrase "works in conjunction with" (line 64) to something more concise like "used with" to improve clarity and reduce wordiness. For example:

-Optional wiki API URL, works in conjunction with `$wgForeignFileRepos` for retrieving images from any wiki
+Optional wiki API URL, used with `$wgForeignFileRepos` for retrieving images from any wiki

🧰 Tools

🪛 LanguageTool

[style] ~67-~67: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...file repo Optional wiki API URL, works in conjunction with $wgForeignFileRepos for retrieving im...

(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6163295 and 97887ad.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[style] ~67-~67: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...file repo Optional wiki API URL, works in conjunction with $wgForeignFileRepos for retrieving im...

(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)