From defd4fc3db81493159b4221839d076e59ea15ad6 Mon Sep 17 00:00:00 2001
From: tux <t@tux.rs>
Date: Wed, 2 Jul 2025 22:08:14 +0530
Subject: [PATCH] doc: update README.md

---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a941c4a..0671f09 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,56 @@
-# highminded
\ No newline at end of file
+<div align="center">
+  <h3 align="center">High Minded</h3>
+  <p align="center">
+    Your undectable personal assistance
+  </p>
+  <p align="center">
+    <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/tuxdotrs/highminded">
+    <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/tuxdotrs/highminded">
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+- [Features](#features)
+- [Installation](#installation)
+- [Keybindings](#keybindings)
+- [Contributing](#contributing)
+- [License](#license)
+
+<!-- FEATURES -->
+## 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.
+- [ ] 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 -->
+## Installation
+Get the appropriate binary for your platform from the [release page](https://github.com/tuxdotrs/highminded/releases).
+
+<!-- KEYBINDINGS -->
+## Keybindings
+
+| Bind | Action |
+| ---- | ------ |
+| `Shift` + `\` | Toggle Window Visibility |
+| `Shift` + `S` | Capture screenshot and send to LLM |
+| `Ctrl` + `Alt` + `Shift`  `H` | Make windows visible to screenshare |
+
+<!-- CONTRIBUTING -->
+## 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".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.