Skip to content

Commit b41bf9a

Browse files
committed
docs: add stars badge and refine feature index
1 parent 57bb3f8 commit b41bf9a

2 files changed

Lines changed: 14 additions & 11 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
<img alt="HeliboardL Banner" src="docs/images/heliboardl_banner_light.svg">
77
</picture>
88

9-
[![Download](https://img.shields.io/github/v/release/LeanBitLab/HeliboardL?label=Download&style=for-the-badge&color=7C4DFF)](https://github.com/LeanBitLab/HeliboardL/releases/latest) [![Downloads](https://img.shields.io/github/downloads/LeanBitLab/HeliboardL/total?style=for-the-badge&color=7C4DFF&label=Downloads)](https://github.com/LeanBitLab/HeliboardL/releases)
9+
[![Download](https://img.shields.io/github/v/release/LeanBitLab/HeliboardL?label=Download&style=for-the-badge&color=7C4DFF)](https://github.com/LeanBitLab/HeliboardL/releases/latest) [![Downloads](https://img.shields.io/github/downloads/LeanBitLab/HeliboardL/total?style=for-the-badge&color=7C4DFF&label=Downloads)](https://github.com/LeanBitLab/HeliboardL/releases) [![Stars](https://img.shields.io/github/stars/LeanBitLab/HeliboardL?style=for-the-badge&color=7C4DFF)](https://github.com/LeanBitLab/HeliboardL/stargazers)
1010

1111
**HeliboardL** is a fork of [HeliBoard](https://github.com/Helium314/HeliBoard) - a privacy-conscious and customizable open-source keyboard based on AOSP/OpenBoard.
1212

1313
This fork adds **optional AI-powered features** using Gemini, Groq, and OpenAI-compatible APIs, offering a hybrid experience: a private, offline core with opt-in cloud intelligence.
1414

1515
## What's New in HeliboardL
1616

17-
- **🤖 Multi-Provider AI** - Proofread using **Gemini**, **Groq** (Llama 3, Mixtral), or **OpenAI-compatible** providers.
18-
- **🛡️ Offline AI** - Private, on-device proofreading and translation using ONNX models (Offline build only).
17+
- **[🤖 Multi-Provider AI](docs/FEATURES.md#supported-ai-providers)** - Proofread using **Gemini**, **Groq** (Llama 3, Mixtral), or **OpenAI-compatible** providers.
18+
- **[🛡️ Offline AI](docs/FEATURES.md#5-offline-proofreading-privacy-focused)** - Private, on-device proofreading and translation using ONNX models (Offline build only).
1919
- **🌐 AI Translation** - Translate selected text directly using your chosen AI provider.
20-
- **🧠 Custom AI Keys** - Assign custom prompts and personas (#editor, #proofread) to 10 customizable toolbar keys.
20+
- **[🧠 Custom AI Keys](docs/FEATURES.md#4-custom-ai-keys--keywords)** - Assign custom prompts and personas (#editor, #proofread) to 10 customizable toolbar keys.
2121
- **⌨️ Dual Toolbar / Split Suggestions** - Option to split suggestions and toolbar for easier access.
2222
- **🖱️ Touchpad Mode** - Swipe spacebar up to toggle touchpad; custom sensitivity controls.
2323
- **🎨 Modern UI** - "Squircle" key backgrounds, refined icons, and polished aesthetics.

docs/FEATURES.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33
HeliboardL integrates with AI providers to offer advanced proofreading and translation capabilities directly within the keyboard. This guide explains how to set up the supported providers.
44

55
## Index
6-
1. [Summary of New Features](#summary-of-new-features) - Quick overview of what's new.
7-
2. [Supported AI Providers](#supported-ai-providers) - Start here to choose your AI backend.
8-
3. [Groq](#1-groq) - Ultra-fast cloud inference.
9-
4. [Google Gemini](#2-google-gemini) - Reliable general-purpose AI.
10-
5. [HF/OpenAI-compatible](#3-hfopenai-compatible-generic-provider) - Use Mistral, DeepSeek, OpenRouter, or HuggingFace.
11-
6. [Custom AI Keys & Keywords](#4-custom-ai-keys--keywords) - **New!** Configure custom prompts and personas.
12-
7. [Offline Proofreading](#5-offline-proofreading-privacy-focused) - Privacy-first, on-device AI.
6+
7+
| Section | Description |
8+
| :--- | :--- |
9+
| 🆕 **[Summary of New Features](#summary-of-new-features)** | Quick overview of what's new. |
10+
| 🤖 **[Supported AI Providers](#supported-ai-providers)** | Start here to choose your AI backend. |
11+
|**[Groq](#1-groq)** | Ultra-fast cloud inference. |
12+
| 🌟 **[Google Gemini](#2-google-gemini)** | Reliable general-purpose AI. |
13+
| ⚙️ **[HF/OpenAI-compatible](#3-hfopenai-compatible-generic-provider)** | Use Mistral, DeepSeek, OpenRouter, etc. |
14+
| 🧠 **[Custom AI Keys](#4-custom-ai-keys--keywords)** | Configure custom prompts and personas. |
15+
| 🛡️ **[Offline Proofreading](#5-offline-proofreading-privacy-focused)** | Privacy-first, on-device AI. |
1316

1417
## Summary of New Features
1518

0 commit comments

Comments
 (0)