Update README.

Author: Frumple

README.md

@@ -4,24 +4,38 @@ A search aggregator for finding Minecraft: Java Edition server plugins on [Spigo
 
 ### Live Application: [https://mcpluginfinder.com](https://mcpluginfinder.com)
 
+## Elevator Pitch
+
+As a Minecraft server owner, have you ever been annoyed when trying to find a plugin? Do I have to search for it on Spigot? Or maybe it's on Modrinth? Or Hangar? And on top of all that, the plugin developer might have only posted their latest version on some platforms but not others. What a mess.
+
+MC Plugin Finder seeks to solve this problem by being the one-stop shop for searching all three of these platforms simultaneously, thanks to their public APIs. You can filter and sort your search results as desired, and you can compare versions of the same plugin on each platform to ensure that you are getting the latest version.
+
 ## How it Works
 
-MC Plugin Finder has two main components: The **ingest** tool and the **web** app.
+MC Plugin Finder has two main components: The **ingest tool** and the **web app**.
+
+The **ingest tool** is a CLI application that retrieves plugin project data from the [Spiget API](https://spiget.org/) (for Spigot), [Modrinth API](https://docs.modrinth.com/), and [Hangar API](https://hangar.papermc.io/api-docs). The tool runs daily to update the database with the latest plugin information. It also considers projects from different plugin repositories to be the same if they **share the same source code repository URL**.
 
-The **ingest** tool is a CLI application that retrieves plugin project data from the [Spiget API](https://spiget.org/) (for Spigot), [Modrinth API](https://docs.modrinth.com/), and [Hangar API](https://hangar.papermc.io/api-docs). The tool runs once per day to update the database with the latest projects, and then creates a common database view for those projects, merging some projects together if they **share the same source code repository URL**.
+For example, suppose there was a project named "Foo" on Spigot and another project named "Bar" on Modrinth, and both projects have `https://github.com/example/asdf` as their source code repository URL. Both projects would be considered the same on MC Plugin Finder, even though their project names are different.
 
-For example, suppose there was a project named "Foo" on Spigot and another project named "Bar" on Modrinth, and both projects have `https://github.com/username/repo` as their source code repository URL. Both projects would be considered the same on MC Plugin Finder, even though their project names are different.
+On the other hand, if there were two projects named "Baz" on Spigot and Modrinth each, but the plugin developer forgot to add a source code URL to one of these plugin repositories, then these projects would **not** be considered be the same on MC Plugin Finder, even though their project names match.
 
-MC Plugin Finder will only recognize URLs from these source code repositories:
+MC Plugin Finder will only recognize URLs from these source code repository hosts:
 - [github.com](https://github.com)
 - [gitlab.com](https://gitlab.com)
 - [bitbucket.org](https://bitbucket.org)
 - [codeberg.org](https://codeberg.org)
 
-The **web** app allows users to search the projects in the common database view.
+The **web app** allows users to search the database for plugins.
+
+The MC Plugin Finder hosted infrastructure runs an instance of [imageproxy](https://github.com/willnorris/imageproxy) to cache plugin project icons from Modrinth and Hangar. This reduces the load on the Modrinth and Hangar CDNs, and provides improved image loading performance. Icon data for Spigot-hosted plugins are provided directly by the Spiget API and stored in the database, so no proxy or caching is needed in that case.
 
 ## Development Setup
 
+### Rust
+
+Install [rustup](https://www.rust-lang.org/tools/install) and the latest version of Rust.
+
 Add the wasm32 target:
 - `rustup target add wasm32-unknown-unknown`
 
@@ -30,11 +44,14 @@ Install Cargo extensions:
 - `cargo install cargo-nextest`
 - `cargo install cargo-leptos`
 
-### Cornucopia
+Build the workspace:
+- `cargo build --workspace`
+
+### PostgreSQL
 
 Ensure that you have Docker or Podman installed on your system. For more details, see the [Cornucopia installation instructions](https://cornucopia-rs.netlify.app/book/introduction/installation).
 
-Setup the initial schema on your database by running [schema.sql](https://github.com/Frumple/mc-plugin-finder/blob/main/schema.sql) on it.
+Setup the initial schema on your PostgreSQL database by running [schema.sql](https://github.com/Frumple/mc-plugin-finder/blob/main/schema.sql) on it.
 
 Set the database settings in the .env file as desired:
 ```
@@ -45,10 +62,24 @@ MCPF_DB_PORT=5432
 MCPF_DB_NAME=mc_plugin_finder
 ```
 
-Regenerate the cornucopia.rs file after making any changes to queries:
-- `cornucopia -d src/database/cornucopia.rs schema schema.sql`
+Run the ingest tool to populate the database, starting with these commands:
+- `ingest populate spigot authors`
+- `ingest populate spigot resources`
+- `ingest populate modrinth projects`
+- `ingest populate hangar projects`
+
+Optionally, you may populate plugin versions as well (However, note that populating Spigot versions takes several hours):
+- `ingest populate spigot versions`
+- `ingest populate modrinth verisons`
+- `ingest populate hangar verisons`
+
+Run the ingest tool again to refresh the common database view:
+- `ingest refresh`
 
-### Run Commands
+### Commands
+
+After making any changes to queries, regenerate your cornucopia.rs file:
+- `cornucopia -d src/database/cornucopia.rs schema schema.sql`
 
 Run tests:
 - `cargo nextest run --workspace`
@@ -66,6 +97,8 @@ Run the web server:
 
 ## License
 
+Copyright © 2025 Frumple
+
 MC Plugin Finder is provided under the [GNU Affero General Public License 3.0](https://github.com/Frumple/mc-plugin-finder/blob/main/LICENSE).
 
 MC Plugin Finder is not an official Minecraft service, and is not approved or associated with Mojang, Microsoft, SpigotMC, Modrinth, or PaperMC.