Skip to content

Commit a2fd8ac

Browse files
committed
docs: overhaul README with new features, updated screenshots, and privacy details
1 parent 0fcc579 commit a2fd8ac

4 files changed

Lines changed: 38 additions & 20 deletions

File tree

README.md

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,47 +11,52 @@
1111
<p align="center">
1212
<img src="https://img.shields.io/badge/Platform-Android-brightgreen.svg" />
1313
<img src="https://img.shields.io/badge/License-GPLv3-blue.svg" />
14-
<img src="https://img.shields.io/badge/Kotlin-1.9+-purple.svg" />
14+
<img src="https://img.shields.io/badge/Kotlin-2.1.0-purple.svg" />
15+
<img src="https://img.shields.io/github/downloads/estiaksoyeb/TypeAssist/total?style=for-the-badge&color=FF5722&label=Downloads" />
1516
</p>
1617

17-
TypeAssist is a powerful Android Accessibility Service that acts as an intelligent layer over your existing keyboard. It integrates cutting-edge AI (Google Gemini, Cloudflare Workers AI) and a suite of offline utility tools directly into any text input field on your device.
18+
TypeAssist is a powerful Android Accessibility Service that acts as an intelligent layer over your existing keyboard. It integrates cutting-edge AI (Google Gemini, Cloudflare Workers AI) and a suite of offline utility tools directly into any text input field on your device.
1819

1920
No more switching apps to fix grammar, translate text, or calculate math. TypeAssist is always just a trigger away.
2021

2122
---
2223

2324
## 📸 Screenshots
2425

25-
<p align="center">
26-
<img src="screenshots/1.png" width="200" />
27-
<img src="screenshots/2.png" width="200" />
28-
<img src="screenshots/3.png" width="200" />
29-
</p>
30-
<p align="center">
31-
<img src="screenshots/4.png" width="200" />
32-
<img src="screenshots/5.png" width="200" />
33-
<img src="screenshots/6.png" width="200" />
34-
</p>
26+
<!-- Screenshots -->
27+
<div align="center">
28+
<img src="screenshots/7.PNG" width="30%" alt=""/>
29+
<img src="screenshots/8.PNG" width="30%" alt=""/>
30+
<img src="screenshots/9.PNG" width="30%" alt=""/>
31+
</div>
3532

3633
---
3734

3835
## ✨ Features
3936

4037
### 🤖 AI Capabilities
41-
* **Ask AI:** Query Google Gemini or Cloudflare Workers AI directly from any app.
38+
* **Ask AI:** Query Google Gemini, Cloudflare Workers AI, or **any OpenAI-compatible Custom API** directly from any app.
4239
* **Grammar Fix:** Instantly correct spelling, punctuation, and grammar errors.
4340
* **Translation:** Translate text from any language to English (or your preferred language).
4441
* **Tone Adjustment:** Rewrite messages to be more professional, polite, or friendly.
4542
* **Inline Commands:** Embed AI queries within sentences using `(.ta: your prompt)`.
43+
* **Global Rewrite:** Transform the entire text field with a custom instruction using `...instruction...`.
44+
* Example: `meeting at 3pm, bring laptop ...expand to formal invite...`
45+
* **Result:** "Please join us for a meeting at 3:00 PM. Kindly remember to bring your laptop as we will be working through some examples together."
4646

4747
### 🛠 Utility Belt (Offline Tools)
4848
* **Smart Calculator:** Solve math expressions in-place.
4949
* Example: `(.c: 25 * 4 + 10)` -> `110`
5050
* **Snippets (Text Expander):** Expand shortcuts into full text blocks.
5151
* Example: `..email` -> `user@example.com`
52+
* **Quick Save:** Save new snippets instantly without opening the app: `(.save:trigger:content)`
5253
* **Date & Time:** Insert current timestamps with `.now` or `.date`.
5354
* **Password Generator:** Generate strong random passwords on the fly with `.pass`.
5455

56+
### 💾 Data Management
57+
* **Backup & Restore:** Securely export your settings, snippets, and API configurations to a `.tabak` file.
58+
* **Saved Configurations:** Save and switch between multiple API setups (e.g., "Personal Gemini", "Work Custom API").
59+
5560
### 🛡 Safety & Privacy
5661
* **Global Undo:** Revert any action instantly using `.undo`.
5762
* **History Manager:** View and recover original text from the last 5 minutes.
@@ -70,15 +75,19 @@ Type your text followed by a trigger to process it.
7075
| `.g` | Fix Grammar | `i go home yestarday .g` |
7176
| `.tr` | Translate | `你好世界 .tr` |
7277
| `.polite` | Polite Tone | `Give me the money .polite` |
78+
| `...` | Global Rewrite | `I am late ...make polite...` |
7379
| `.undo` | Undo | Reverts the last replacement |
7480

81+
82+
7583
---
7684

7785
## 📥 Installation & Setup
7886

7987
1. **Download:** Get the latest APK from the [Releases](https://github.com/estiaksoyeb/TypeAssist/releases) page.
8088
2. **Permissions:** Enable the **TypeAssist Accessibility Service** in your Android Settings.
81-
3. **API Key:** Open the app, go to **Settings**, and add your **Google Gemini** or **Cloudflare** API key.
89+
3. **API Key:** Open the app, go to **Settings**, and add your API keys.
90+
* Supports Google Gemini, Cloudflare Workers AI, and Custom OpenAI Endpoints.
8291
4. **Start Typing:** Open any app (WhatsApp, Notes, Chrome) and try a trigger!
8392

8493
---
@@ -100,9 +109,10 @@ If TypeAssist helps you in your daily workflow, consider supporting the developm
100109

101110
## 🛠 Tech Stack
102111
* **UI:** Jetpack Compose (Material 3)
103-
* **Language:** Kotlin
112+
* **Language:** Kotlin 2.1.0
104113
* **Network:** OkHttp / Gson
105114
* **Service:** Android AccessibilityService
115+
* **Architecture:** MVVM
106116

107117
---
108118

@@ -111,8 +121,16 @@ Distributed under the **GPLv3 License**. See `LICENSE` for more information.
111121

112122
---
113123

114-
## 🔒 Privacy Note
115-
TypeAssist uses an Accessibility Service to function.
116-
- It does **not** log your keystrokes.
117-
- It does **not** send data to any server unless you explicitly use an AI trigger (`.ta`, `.g`, etc.).
118-
- It is fully **Open Source**, so you can audit the code yourself for peace of mind.
124+
## 🔒 Privacy & Data Security
125+
126+
TypeAssist is designed with a **Zero-Middleman Architecture** to ensure your privacy is paramount.
127+
128+
### How We Handle Data
129+
* **Direct Connection:** Text is sent **directly** from your device to your chosen API provider (Google or Cloudflare). **No intermediate servers** are used, meaning we have no access to your data.
130+
* **On-Demand Only:** The Accessibility Service runs locally. No data leaves your device unless you explicitly type a trigger (e.g., `.ta`, `.g`).
131+
* **Open Source:** The entire codebase is open for audit. You can verify exactly how your data is handled.
132+
133+
### 📜 Provider Policies
134+
Your input data is processed by the provider you configure. Please review their policies:
135+
* **Google Gemini:** [API Terms of Service](https://ai.google.dev/gemini-api/terms)
136+
* **Cloudflare Workers AI:** [Data Usage & Privacy](https://developers.cloudflare.com/workers-ai/platform/data-usage/)

screenshots/7.PNG

524 KB
Loading

screenshots/8.PNG

613 KB
Loading

screenshots/9.PNG

619 KB
Loading

0 commit comments

Comments
 (0)