You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-42Lines changed: 38 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,27 +10,30 @@
10
10
11
11
**HeliboardL** is a fork of [HeliBoard](https://github.com/Helium314/HeliBoard) - a privacy-conscious and customizable open-source keyboard based on AOSP/OpenBoard.
12
12
13
-
This fork adds **AI-powered features** using the Gemini API while maintaining the offline-first philosophy of the original.
13
+
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.
14
14
15
15
## What's New in HeliboardL
16
16
17
-
-**🤖 Gemini AI Proofreading** - Fix grammar and spelling with one tap (Standard only)
18
-
-**🌐 AI Translation** - Translate selected text directly (Standard only)
19
-
-**🎨 Modern UI** - "Squircle" key backgrounds and refined icons (incognito, etc.)
@@ -41,17 +44,18 @@ You can download the latest release from the [GitHub Releases](https://github.co
41
44
42
45
### 📦 Choose Your Version
43
46
44
-
We provide two distinct versions. **Note:** Both versions use the same package name (`helium314.keyboard.l`) and signature. You can only have **one** installed at a time.
45
-
46
47
#### 1. Standard Version (`-standard-release.apk`)
47
48
***Features:** Full suite including **AI Proofreading**, **AI Translation**, and **Gesture Library Downloader**.
48
-
***Permissions:** Request `INTERNET` permission (used *only* when you explicitly use AI features or download libraries).
49
-
***Best For:**Users who want smart features alongside privacy.
49
+
***Permissions:** Request `INTERNET` permission (used *only* when you explicitly use AI features).
50
+
***Setup:**Use the built-in downloader for Gesture Typing. Configure AI keys in Settings.
50
51
51
52
#### 2. Offline Version (`-offline-release.apk`)
52
-
***Features:** All UI/UX refinements (Squircle keys, new Icons) but **excludes** all AI and network features.
53
-
***Permissions:****NO INTERNET PERMISSION** in the manifest. Guaranteed at the OS level.
54
-
***Best For:** Privacy purists who require a hard guarantee that no data can ever leave the device.
53
+
***Features:** All UI/UX enhancements and **Offline Neural Proofreading** (ONNX).
54
+
***Permissions:****NO INTERNET PERMISSION**. Guaranteed at OS level.
55
+
***Best For:** Privacy purists.
56
+
***Manual Setup Required:**
57
+
***Gesture Typing:**[Download library manually](https://github.com/Helium314/HeliBoard/blob/master/app/src/main/jniLibs/arm64-v8a/libjni_latinimegoogle.so) and load via *Settings > Advanced*.
58
+
***Offline AI:** Download ONNX models and load via *Settings > AI Integration*. 👉 **[See Offline Setup Instructions](docs/FEATURES.md#3-offline-proofreading-privacy-focused)**
55
59
56
60
## Original HeliBoard Features
57
61
@@ -60,7 +64,7 @@ We provide two distinct versions. **Note:** Both versions use the same package n
60
64
<li>Customize keyboard themes (style, colors and background image)</li>
@@ -72,30 +76,22 @@ For original feature documentation, visit the [HeliBoard Wiki](https://github.co
72
76
73
77
## Setup
74
78
75
-
### Gemini API Key (for AI features)
76
-
1. Get your free API key from [Google AI Studio](https://aistudio.google.com/apikey)
77
-
2. Go to HeliboardL Settings → Advanced → Gemini API Key
78
-
3. Enter your API key
79
-
4. Change Gemini model to **gemini-2.5-flash** or **gemini-3n-e2b-it** for best performance.
79
+
### AI Features Setup
80
+
81
+
HeliboardL supports multiple AI providers: **Google Gemini**, **Groq**, and **OpenAI-compatible** (OpenRouter, HuggingFace, etc.).
82
+
83
+
👉 **[Read the Full AI Setup & Features Guide](docs/FEATURES.md)**
80
84
81
-
### AI Translation Setup
82
-
1. Go to Settings → Toolbar → Customize Toolbar and add the "Translate" key.
83
-
2. Go to **Settings → Advanced → Translation Target Language** and select your desired output language.
85
+
**Quick Start:**
86
+
1. Get a free key from [Google AI Studio](https://aistudio.google.com/apikey) (Gemini) or [Groq Console](https://console.groq.com/keys) (Groq).
87
+
2. Copy the API key.
88
+
3. Go to **Settings → AI Integration → Set AI Provider**.
89
+
4. Select your provider and paste the API Token.
90
+
5. Select Model and target language
84
91
85
92
> [!IMPORTANT]
86
-
> **Privacy Notice**: While HeliboardL itself is open-source and respects your privacy, using the **free tier** of the Google Gemini API means your input data may be used by Google to improve their models.
87
-
> - Using AI features is **optional**.
88
-
> -**Do not process sensitive information** (passwords, credit card numbers, private addresses) using the AI Proofreading or Translation features.
89
-
> - The **Offline Version** completely removes this code and permission.
90
-
91
-
### Gesture/Glide Typing
92
-
**Standard Version:** Use the built-in downloader in Settings → Advanced → Load Gesture Typing Library.
93
-
94
-
**Offline Version:**
95
-
Since network access is disabled, you must manually install the library:
96
-
1. Download the library file: [libjni_latinimegoogle.so](https://github.com/Helium314/HeliBoard/blob/master/app/src/main/jniLibs/arm64-v8a/libjni_latinimegoogle.so) (for arm64)
97
-
2. Go to Settings → Advanced → Load Gesture Typing Library.
98
-
3. Select "Load from file" and pick the downloaded `.so` file.
93
+
> **Privacy**: Your input data is sent to the configured provider.
94
+
> 👉 **[View Privacy Policies for Providers](docs/FEATURES.md#supported-ai-providers)**
0 commit comments