From 97763a1301ff767f64b0311dfbc4554e199b0fc7 Mon Sep 17 00:00:00 2001 From: Gregory Schier Date: Sun, 8 Jun 2025 08:03:11 -0700 Subject: [PATCH] Add README to types package --- packages/plugin-runtime-types/README.md | 23 ++++++++++++++++++++++ packages/plugin-runtime-types/package.json | 8 +++++++- 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 packages/plugin-runtime-types/README.md diff --git a/packages/plugin-runtime-types/README.md b/packages/plugin-runtime-types/README.md new file mode 100644 index 00000000..02178bef --- /dev/null +++ b/packages/plugin-runtime-types/README.md @@ -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 +``` diff --git a/packages/plugin-runtime-types/package.json b/packages/plugin-runtime-types/package.json index 510732ec..5c9722df 100644 --- a/packages/plugin-runtime-types/package.json +++ b/packages/plugin-runtime-types/package.json @@ -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": [