From 8a299b0cf2e0d7379fc6a265108c0d046578654c Mon Sep 17 00:00:00 2001 From: tux Date: Fri, 4 Jul 2025 20:14:25 +0530 Subject: [PATCH] doc: update README.md --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cf45d55..541b3d7 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,9 @@ + ## Table of Contents + - [Features](#features) - [Installation](#installation) - [Keybindings](#keybindings) @@ -22,31 +24,40 @@ - [License](#license) + ## Features + - [x] Undectable Window - The application window remains hidden during screen sharing, ensuring complete discretion. - [x] Screen Capture - Capture your screen and receive relevant insights or assistance based on the content. - [x] BYO Model - Bring your own LLM—works with any model supporting the OpenAI-compatible API. - [x] Custom Prompt - Define your own prompt to guide the assistant according to your specific needs. +- [x] Conversation - Get smarter replies with awareness of ongoing conversation context. (MacOS planned) - [ ] Custom Keybindings - Fully customizable keyboard shortcuts—tailor the tool to your workflow. (planned) -- [ ] Conversation - Get smarter replies with awareness of ongoing conversation context. (planned) + ## Installation + Get the appropriate binary for your platform from the [release page](https://github.com/tuxdotrs/highminded/releases). + ## Keybindings | Bind | Action | |--------------------------------|----------------------------------------------------------------------------------------------------------------| | `Shift` + `\` | Toggle Window Visibility | | `Shift` + `S` | Capture screenshot and send to LLM | +| `Shift` + `A` | Capture audio and send to LLM | | `Alt` + `Shift` + `Q` | Quit application | | `Ctrl` + `Alt` + `Shift` + `H` | Make windows visible to screenshare.
**Note: Application restart is required to make it invisible again.** | + ## Contributing -If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also +simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! 1. Fork the Project @@ -56,6 +67,7 @@ Don't forget to give the project a star! Thanks again! 5. Open a Pull Request + ## License Distributed under the MIT License. See `LICENSE` for more information.