mirror of
https://github.com/mountain-loop/yaak.git
synced 2026-04-23 00:58:32 +02:00
Add README to types package
This commit is contained in:
23
packages/plugin-runtime-types/README.md
Normal file
23
packages/plugin-runtime-types/README.md
Normal 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
|
||||||
|
```
|
||||||
@@ -1,6 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@yaakapp/api",
|
"name": "@yaakapp/api",
|
||||||
"version": "0.6.0",
|
"version": "0.6.1",
|
||||||
|
"keywords": [
|
||||||
|
"api-client",
|
||||||
|
"insomnia-alternative",
|
||||||
|
"bruno-alternative",
|
||||||
|
"postman-alternative"
|
||||||
|
],
|
||||||
"main": "lib/index.js",
|
"main": "lib/index.js",
|
||||||
"typings": "./lib/index.d.ts",
|
"typings": "./lib/index.d.ts",
|
||||||
"files": [
|
"files": [
|
||||||
|
|||||||
Reference in New Issue
Block a user