Add README to types package

This commit is contained in:
Gregory Schier
2025-06-08 08:03:11 -07:00
parent d8b5a201b6
commit 97763a1301
2 changed files with 30 additions and 1 deletions

View File

@@ -0,0 +1,23 @@
# Yaak Plugin API
Yaak is a desktop API client for interacting with REST, GraphQL, Server Sent Events (SSE),
WebSocket, and gRPC APIs. It's built using Tauri, Rust, and ReactJS.
Yaak plugins are written in TypeScript and executed within a NodeJS runtime. This package
contains the TypeScript type definitions required to make building Yaak plugins a breeze.
## Quick Start
The easiest way to get started is by generating a plugin with the Yaak CLI:
```shell
npx @yaakapp/cli generate
```
## Installation
If you prefer starting from scratch, manually install the types package:
```shell
npm install @yaakapp/api
```

View File

@@ -1,6 +1,12 @@
{
"name": "@yaakapp/api",
"version": "0.6.0",
"version": "0.6.1",
"keywords": [
"api-client",
"insomnia-alternative",
"bruno-alternative",
"postman-alternative"
],
"main": "lib/index.js",
"typings": "./lib/index.d.ts",
"files": [