From 6826ee167262716e97eb4965f96c15e42b532d92 Mon Sep 17 00:00:00 2001 From: Gregory Schier Date: Fri, 3 Oct 2025 10:29:19 -0700 Subject: [PATCH] Revise README for clarity and updated features Updated the README to enhance clarity and organization, including feature descriptions and removing outdated content. --- README.md | 67 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 36 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 158cdbb3..304875eb 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,22 @@ -

-

- โญ Yaak โ€“ Desktop API Client โญ + ๐Ÿ’ซ Yaak โžŸ Desktop API Client ๐Ÿ’ซ

- A desktop API client for REST, GraphQL, SSE, WebSocket, and gRPC - APIs. It's built using Tauri, Rust, and React. + A fast, privacy-first API client for REST, GraphQL, SSE, WebSocket, and gRPC โ€“ built with Tauri, Rust, and React.

- Development is supported by community-purchased licenses. You can also become a sponsor to have your avatar or company logo appear below. ๐Ÿ’– + Development is funded by community-purchased licenses. You can also become a sponsor to have your logo appear below. ๐Ÿ’–

-
+
+ +

User avatar: MVST-Solutions  User avatar: dharsanb  User avatar: railwayapp  User avatar: caseyamcl  User avatar: andriyor  User avatar:    @@ -35,28 +27,40 @@ ![Yaak API Client](https://yaak.app/static/screenshot.png) + +## Features + +Yaak is an offline-first API client designed to stay out of your way while giving you everything you need when you need it. +Built with [Tauri](https://tauri.app), Rust, and React, itโ€™s fast, lightweight, and private. No telemetry, no VC funding, and no cloud lock-in. + + +### ๐ŸŒ Work with any API + +- Import collections from Postman, Insomnia, OpenAPI, Swagger, or Curl. +- Send requests via REST, GraphQL, gRPC, WebSocket, or Server-Sent Events. +- Filter and inspect responses with JSONPath or XPath. + +### ๐Ÿ” Stay secure +- Use OAuth 2.0, JWT, Basic Auth, or custom plugins for authentication. +- Secure sensitive values with end-to-end encryption. +- Store secrets in your OS keychain. + +### โ˜๏ธ Organize & collaborate +- Group requests into workspaces and nested folders. +- Use environment variables to switch between dev, staging, and prod. +- Mirror workspaces to your filesystem for versioning in Git or syncing with Dropbox. + +### ๐Ÿงฉ Extend & customize +- Insert dynamic values like UUIDs or timestamps with template tags. +- Pick from built-in themes or build your own. +- Create plugins to extend authentication, template tags, or the UI. + + ## Contribution Policy Yaak is open source, but only accepting contributions for bug fixes. To get started, visit [`DEVELOPMENT.md`](DEVELOPMENT.md) for tips on setting up your environment. -## Feature Overview - -- ๐Ÿช‚ Import data from Postman, Insomnia, OpenAPI, Swagger, or Curl.
-- ๐Ÿ“ค Send requests via REST, GraphQL, Server Sent Events (SSE), WebSockets, or gRPC.
-- ๐Ÿ” Automatically authorize requests with OAuth 2.0, JWT tokens, Basic Auth, and more.
-- ๐Ÿ”Ž Filter response bodies using JSONPath or XPath queries.
-- โ›“๏ธ Chain together multiple requests to dynamically reference values.
-- ๐Ÿ“‚ Organize requests into workspaces and nested folders.
-- ๐Ÿงฎ Use environment variables to easily switch between Prod and Dev.
-- ๐Ÿ›ก๏ธ Secure arbitrary text values with end-to-end encryption
-- ๐Ÿท๏ธ Send dynamic values like UUIDs or timestamps using template tags.
-- ๐ŸŽจ Choose from many of the included themes, or make your own.
-- ๐Ÿ’ฝ Mirror workspace data to a directory for integration with Git or Dropbox.
-- ๐Ÿ“œ View response history for each request.
-- ๐Ÿ”Œ Create your own plugins for authentication, template tags, and more!
-- ๐Ÿ›œ Configure a proxy to access firewall-blocked APIs - ## Useful Resources - [Feedback and Bug Reports](https://feedback.yaak.app) @@ -64,3 +68,4 @@ visit [`DEVELOPMENT.md`](DEVELOPMENT.md) for tips on setting up your environment - [Yaak vs Postman](https://yaak.app/alternatives/postman) - [Yaak vs Bruno](https://yaak.app/alternatives/bruno) - [Yaak vs Insomnia](https://yaak.app/alternatives/insomnia) +