diff --git a/README.md b/README.md new file mode 100644 index 0000000..f210dc0 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# BRAT (Gitea Fork) + +A fork of [obsidian42-brat](https://github.com/TfTHacker/obsidian42-brat) that adds support for **self-hosted Gitea/Forgejo instances** alongside GitHub. + +## What is this? + +BRAT (Beta Reviewers Auto-update Tester) lets you install and auto-update beta Obsidian plugins directly from any git forge that supports releases. This fork extends the original to work with **any Gitea instance** — not just GitHub. + +## Usage + +Open the BRAT command palette and choose **"Add a beta plugin for testing"**, then paste a repository URL: + +| Source | Format | Example | +|---|---|---| +| **GitHub** | `user/repo` or `https://github.com/user/repo` | `TfTHacker/obsidian42-brat` | +| **Gitea** | `https://git.your-instance.com/user/repo` | `https://gitea.mithrilforge.dev/olivier/BindThem` | + +The plugin auto-detects the provider from the URL. Each plugin entry stores its own Gitea instance URL and optional access token. + +## Installation + +Download the latest release assets (`main.js`, `manifest.json`, `styles.css`) and place them in: + +``` +.obsidian/plugins/obsidian42-brat-gitea/ +``` + +Then enable **BRAT (Gitea Fork)** in Settings → Community Plugins. + +## Features + +- Install plugins from **GitHub** (bare `user/repo` format, backward compatible) +- Install plugins from **Gitea / Forgejo** (full URL format) +- Per-plugin token management via Obsidian SecretStorage +- Frozen version pinning, incompatible plugin overrides +- Theme installation and updates +- Same UI and commands as the original BRAT + +## Credits + +Original BRAT by [TfTHacker](https://github.com/TfTHacker/obsidian42-brat) and [johannrichard](https://github.com/johannrichard). \ No newline at end of file