Files
promptkit-backend-openrouter/README.md

43 lines
1.9 KiB
Markdown

# Promptkit OpenRouter Catalog
This repository publishes immutable OpenRouter catalog assets for Promptkit.
It supplies catalog data only; it does not implement provider behavior, load
credentials, or make network requests.
Promptkit owns catalog parsing, validation, runtime behavior, credential
handling, and consumer documentation. This module owns the OpenRouter backend
manifest and its maintained profile data. Consumers should use versions chosen
by their Promptkit release rather than treating this module as a standalone
runtime integration.
The profile assets originated in Promptkit. Their copyright holder has
authorized their distribution under MIT along with this repository's Go code
and documentation.
## Compatibility
This compatibility policy applies to the `/v2` module. Catalog profiles track
upstream availability and may be added, removed, renamed, or modified without
deprecation or advance notice. Consumers that need a particular profile set
should use the catalog version selected by their Promptkit release.
Backend definitions, the exported Go API, and the catalog manifest schema do
not share that profile-data exception. Their compatibility follows the normal
semantic-versioning rules. Published v1 releases retain their historical
contract; this README does not retroactively alter it.
Catalog releases use dated versions in the form `v2.YYYYMMDD.N`. The date
identifies when the catalog snapshot was published in UTC; it does not certify
that a provider currently offers a model or endpoint named by the data.
## Validation and releases
Run the offline Go tests, race tests, vet, build, formatting, hygiene, and
module-resolution checks before release. The complete source-only release
procedure is in [docs/release.md](docs/release.md).
## License
This catalog is licensed under the [MIT License](COPYRIGHT).
The complete license text is available in [LICENSE](LICENSE).