feat: update readme
This commit is contained in:
parent
5cb3cd9794
commit
aab7fa7d72
@ -13,7 +13,6 @@ including the following steps:
|
|||||||
- Retrieve [Zotero](https://www.zotero.org) add-on information specified in [addons](addons) folder
|
- Retrieve [Zotero](https://www.zotero.org) add-on information specified in [addons](addons) folder
|
||||||
- Parse add-on information into JSON data
|
- Parse add-on information into JSON data
|
||||||
- Publish the JSON data to the [`publish`](https://github.com/syt2/zotero-addons-scraper/blob/publish/addon_infos.json) branch and the [latest release](https://github.com/syt2/zotero-addons-scraper/releases/latest)
|
- Publish the JSON data to the [`publish`](https://github.com/syt2/zotero-addons-scraper/blob/publish/addon_infos.json) branch and the [latest release](https://github.com/syt2/zotero-addons-scraper/releases/latest)
|
||||||
- Validate changed addon tag metadata in CI
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
Adding a new add-on entry `{owner}@{repo}` in the [addons](addons) folder.
|
Adding a new add-on entry `{owner}@{repo}` in the [addons](addons) folder.
|
||||||
@ -36,11 +35,6 @@ Available tags:
|
|||||||
| `integration` | Integration with external services (Notion, Obsidian, Word, etc.) |
|
| `integration` | Integration with external services (Notion, Obsidian, Word, etc.) |
|
||||||
| `utility` | Zotero system tools (automation, deduplication, plugin management) |
|
| `utility` | Zotero system tools (automation, deduplication, plugin management) |
|
||||||
|
|
||||||
### Tag validation in CI
|
|
||||||
- `pull_request` on `addons/**`: validates changed addon files against the allowed tag taxonomy
|
|
||||||
- `push` to `master`: validates changed addon files before the scraper publishes data
|
|
||||||
- Each addon config must declare at least one tag, use only allowed tag values, avoid duplicates, and keep tags in canonical order
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
1. `fork` this repository
|
1. `fork` this repository
|
||||||
2. Enable actions and scheduled workflow in `Actions` page of forked repository
|
2. Enable actions and scheduled workflow in `Actions` page of forked repository
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user