diff --git a/README.md b/README.md index 5ca3dba..cabb074 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,9 @@ Create a beautifully structured, developer-first showcase directory for your Wor 1. In the WordPress® admin, go to **Projects → Add New**. 2. Add your project title, description, and featured image. 3. Select a **Project Type**: Plugin, Theme, or Pattern. -4. In the sidebar, paste the GitHub Repository URL (e.g., `https://github.com/username/repo`). -5. Publish. +4. In the sidebar, choose **Provider** (GitHub or Gitea) and paste the **Repository URL** (e.g., `https://github.com/username/repo` or `https://codeberg.org/username/repo`). +5. For Gitea projects, optionally set a **Gitea Base URL** to override the global default. +6. Publish. ### Enable Download Link @@ -55,7 +56,7 @@ Each project automatically gets a unique download endpoint: Example: `https://example.com/download/123` -This URL fetches the latest `.zip` release from GitHub and increments the download count. +This URL fetches the latest `.zip` release from the project's host (GitHub or Gitea) and increments the download count. ## Settings Overview @@ -64,6 +65,8 @@ Navigate to **Projects → Settings** to configure: ### General Settings - **GitHub API Token** – Recommended for authenticated requests (avoids GitHub rate limits). +- **Default Gitea Base URL** – Used when a Gitea project doesn't specify one. Defaults to `https://codeberg.org`. +- **Gitea API Token** – Recommended for authenticated Gitea requests. - **Telemetry** – Toggle to help improve the plugin. ### Templates Settings @@ -102,6 +105,22 @@ To avoid hitting rate limits or improve reliability: 2. Generate a token (no scopes required). 3. Paste it into the settings screen under **GitHub API Token**. +## Connect Your Gitea Repo + +To connect a project to a Gitea instance (self-hosted or public): + +1. Set **Provider** to **Gitea** in the project editor. +2. Paste the full repository URL into **Repository URL** (e.g., `https://codeberg.org/username/repo`). +3. Optionally override the Gitea base URL for this project (leave blank to use the global default). +4. Make sure the repo has a release with a `.zip` asset, or any tag — the plugin will fall back to the source archive URL. + +### Optional: Add a Gitea API Token + +To avoid rate limits or improve reliability: + +1. In your Gitea instance, go to **Settings → Applications** and generate a token. +2. Paste it into the plugin settings screen under **Gitea API Token**. + ## How to Zip the Plugin for GitHub Releases When attaching the plugin to a GitHub release: