Link docs in readme

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

View File

@@ -3,8 +3,9 @@
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.
Plugins can be created in TypeScript, which are executed alongside Yaak in a NodeJS
runtime. This package contains the TypeScript type definitions required to make building
Yaak plugins a breeze.
## 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
```
For more details on creating plugins, check out
the [Quick Start Guide](https://feedback.yaak.app/help/articles/6911763-plugins-quick-start)
## Installation
If you prefer starting from scratch, manually install the types package:

View File

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