starred/yaak-mountain-loop
1
0
Fork 0
mirror of https://github.com/mountain-loop/yaak.git synced 2026-04-24 01:28:35 +02:00
Code Issues 8 Packages Projects Releases 10 Wiki Activity

Link docs in readme

Browse Source
This commit is contained in:
Gregory Schier
2025-06-08 08:05:59 -07:00
parent 97763a1301
commit 4d90bc78b1
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/plugin-runtime-types/README.md
View File

@@ -3,8 +3,9 @@
Yaak is a desktop API client for interacting with REST, GraphQL, Server Sent Events (SSE), 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. 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 Plugins can be created in TypeScript, which are executed alongside Yaak in a NodeJS
contains the TypeScript type definitions required to make building Yaak plugins a breeze. runtime. This package contains the TypeScript type definitions required to make building
Yaak plugins a breeze.
## Quick Start ## Quick Start
@@ -14,6 +15,9 @@ The easiest way to get started is by generating a plugin with the Yaak CLI:
npx @yaakapp/cli generate npx @yaakapp/cli generate
``` ```
For more details on creating plugins, check out
the [Quick Start Guide](https://feedback.yaak.app/help/articles/6911763-plugins-quick-start)
## Installation ## Installation
If you prefer starting from scratch, manually install the types package: If you prefer starting from scratch, manually install the types package:

2
packages/plugin-runtime-types/package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "@yaakapp/api", "name": "@yaakapp/api",
"version": "0.6.1", "version": "0.6.2",
"keywords": [ "keywords": [
"api-client", "api-client",
"insomnia-alternative", "insomnia-alternative",