kunkun/packages/api/README.md
Huakun Shen 46d6872614
refactor: Command class rename (#90)
* refactor: rename WorkerExtension to TemplateUiCommand, HeadlessWorkerExtension to HeadlessCommand

* ci: update npm publish workflow to include refactor branch

* ci: add push trigger for JSR publish workflow and bump API package version

* ci: add pnpm setup to npm publish workflow

* chore: add repository field to package.json for @kksh/api
2025-02-05 12:16:33 -05:00

32 lines
817 B
Markdown

# @kksh/api
[![NPM Version](https://img.shields.io/npm/v/%40kksh%2Fapi)](https://www.npmjs.com/package/@kksh/api)
[![JSR Badge](https://jsr.io/badges/@kunkun/api)](https://jsr.io/@kunkun/api)
[Kunkun API](https://www.npmjs.com/package/@kksh/api) is an NPM package designed for developers to create extensions for Kunkun.
On NPM this package is published as `@kksh/api`, and on JSR it is published as `@kunkun/api`.
`@kksh/api` provides a set of APIs for extensions to interact with Kunkun and System APIs. The APIs include:
- Clipboard
- Database
- Dialog
- Event
- Fetch
- File System
- Logger
- Network
- Notification
- Open
- OS
- Path
- Shell
- System Info
- System Commands
- Toast
- UI
- etc.
Read more details in documentation at https://docs.kunkun.sh, and generated docs at https://docs.api.kunkun.sh/