Publish the Promptkit engine facade
This commit is contained in:
20
README.md
20
README.md
@@ -1,23 +1,21 @@
|
||||
# Promptkit
|
||||
|
||||
Promptkit is the reusable Go prompt-execution framework being separated from
|
||||
Scriptorium. Its module path is:
|
||||
Promptkit is a reusable Go library for preparing and executing prompt-defined
|
||||
LLM workflows. Its module path is:
|
||||
|
||||
```text
|
||||
gitea.maximumdirect.net/eric/promptkit
|
||||
```
|
||||
|
||||
Framework extraction is in progress. The repository now contains the
|
||||
`internal/domain` model, application-neutral `internal/defaults`, and
|
||||
`internal/filecatalog` helpers that form the implementation foundation. It also
|
||||
contains internal prompt-definition and profile repositories, the embedded
|
||||
built-in profile catalog, artifact loading, Go-template rendering, output
|
||||
validation, model generation, and orchestration. These internal packages are
|
||||
not a consumer API, and the root package does not yet provide a usable public
|
||||
framework API, so there is no installation or usage example at this time.
|
||||
The root `promptkit` package provides the supported public engine. Consumers
|
||||
can configure filesystem or in-memory prompt, profile, and schema sources,
|
||||
prepare requests without generation, run requests with the built-in
|
||||
OpenAI-compatible client, or inject their own model client and artifact reader.
|
||||
See the [Go package consumer guide](docs/consumers/pkg-promptkit.md) for the
|
||||
public workflow and contract.
|
||||
|
||||
Contributors should start with the [development guide](docs/development.md).
|
||||
The [architecture policy](docs/policy/architecture.md) defines the library
|
||||
boundary and constraints that future framework work must preserve.
|
||||
boundary and constraints that framework work must preserve.
|
||||
|
||||
Promptkit is licensed under the [GNU General Public License version 3](LICENSE).
|
||||
|
||||
Reference in New Issue
Block a user