Skip to content

Commit 4cc17ae

Browse files
authored
Update README.md
1 parent 6b567f3 commit 4cc17ae

File tree

1 file changed

+42
-8
lines changed

1 file changed

+42
-8
lines changed

README.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -173,23 +173,57 @@ A **public JSON API** is available via GitHub Pages:
173173
https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/
174174
```
175175

176+
176177
It is **read-only**, auto-updated on `main`, and sourced from
177178
[`plugins-and-themes.json`](./generated/json/plugins-and-themes.json).
178179

179-
### Key Endpoints
180-
- **[`index.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/index.json)** – full dataset
181-
- **[`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
182-
- **[`stats.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/stats.json)** – aggregate counts
183-
- **[`versions.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/versions.json)** – supported Minecraft versions
184-
- **[`creators.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/creators.json)** – all creators
180+
---
181+
182+
### Core dataset
183+
- **[`index.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/index.json)** – full dataset (plugins + themes)
184+
- **[`plugins.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/plugins.json)** – plugins only
185+
- **[`themes.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/themes.json)** – themes only
186+
187+
---
188+
189+
### Metadata & helpers
190+
- **[`stats.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/stats.json)** – aggregate counts by type, version, creator
191+
- **[`versions.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/versions.json)** – supported Minecraft versions (canonical list)
192+
- **[`creators.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/creators.json)** – all creators with item counts
193+
- **[`meta.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/meta.json)** – generation timestamp + counts + version info
194+
- **[`manifest.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/manifest.json)** – file sizes + SHA256 hashes
195+
- **[`search-index.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/search-index.json)** – compact index for client-side search
196+
197+
---
198+
199+
### Activity (new / recently updated)
200+
These use the `added_at` / `updated_at` fields in the dataset:
201+
202+
- **[`new.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/new.json)**
203+
All plugins and themes sorted by **most recently added** (newest `added_at` first).
204+
205+
- **[`recent.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/recent.json)**
206+
All plugins and themes sorted by **most recently updated** (newest `updated_at` / `added_at` first).
207+
208+
---
209+
210+
### Per-item & buckets
185211
- **`/items/{owner}/{repo}.json`** – per-item info
212+
Example:
213+
[`items/kybe236/rusher-silent-close.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/items/kybe236/rusher-silent-close.json)
214+
186215
- **`/by-version/{mc_version}.json`** – filter by MC version
187-
- **`/by-creator/{creator}.json`** – filter by creator
216+
Example:
217+
[`by-version/1.21.4.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/by-version/1.21.4.json)
188218

219+
- **`/by-creator/{creator}.json`** – filter by creator slug
220+
Example:
221+
[`by-creator/tillay.json`](https://rusherdevelopment.github.io/rusherhack-plugins/api/v1/by-creator/tillay.json)
189222

190-
See [API.md](./API.md) for full reference.
223+
See [API.md](./API.md) for full reference and usage examples.
191224
</details>
192225

226+
193227
## Reporting Issues
194228

195229
If you encounter issues with a specific plugin, contact the plugin’s creator or open an issue in their repository.

0 commit comments

Comments
 (0)