Skip to content

Commit c1c3635

Browse files
authored
Update README.md
1 parent 3b2650c commit c1c3635

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -164,29 +164,26 @@ Themes customize RusherHack’s appearance, including colors, fonts, and UI elem
164164

165165
## Plugin/Theme API
166166

167-
This repository now publishes a **public JSON API** via GitHub Pages:
167+
A **public JSON API** is available via GitHub Pages:
168168

169169
```
170170
https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/
171171
```
172172

173-
All endpoints are **read-only** and automatically updated whenever `main` changes.
174-
The canonical source is [`plugins-and-themes.json`](./generated/json/plugins-and-themes.json).
173+
It is **read-only**, auto-updated on `main`, and sourced from
174+
[`plugins-and-themes.json`](./generated/json/plugins-and-themes.json).
175175

176-
### Endpoints
177-
178-
- **[`index.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/index.json)** – full dataset (plugins + themes)
179-
- **[`plugins.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/plugins.json)** – plugins only
180-
- **[`themes.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/themes.json)** – themes only
176+
### Key Endpoints
177+
- **[`index.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/index.json)** – full dataset
178+
- **[`plugins.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/plugins.json)** / **[`themes.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/themes.json)** – split views
181179
- **[`stats.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/stats.json)** – aggregate counts
182-
- **[`versions.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/versions.json)** – all supported Minecraft versions
183-
- **[`creators.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/creators.json)** – all creators with counts
184-
- **`/items/{owner}/{repo}.json`** – per-plugin/theme info
185-
- **`/by-version/{mc_version}.json`** – all items supporting a given Minecraft version
186-
- **`/by-creator/{creator}.json`** – all items by a creator
187-
188-
Full API reference is available in [API](./API.md).
180+
- **[`versions.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/versions.json)** – supported Minecraft versions
181+
- **[`creators.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/creators.json)** – all creators
182+
- **`/items/{owner}/{repo}.json`** – per-item info
183+
- **`/by-version/{mc_version}.json`** – filter by MC version
184+
- **`/by-creator/{creator}.json`** – filter by creator
189185

186+
📖 See [API.md](./API.md) for full reference.
190187

191188
## Reporting Issues
192189

0 commit comments

Comments
 (0)