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 +
+

High Minded

+

+ Your undectable personal assistance +

+

+ GitHub repo size + GitHub commit activity +

+
+ + +## Table of Contents +- [Features](#features) +- [Installation](#installation) +- [Keybindings](#keybindings) +- [Contributing](#contributing) +- [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. +- [ ] 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 | +| `Ctrl` + `Alt` + `Shift` `H` | Make windows visible to screenshare | + + +## 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 + +Distributed under the MIT License. See `LICENSE` for more information.