Skip to content

Commit 3ce90e8

Browse files
committed
Fix emojis and layout in README
1 parent 2b14124 commit 3ce90e8

1 file changed

Lines changed: 45 additions & 52 deletions

File tree

README.md

Lines changed: 45 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
1-
# FastKeylogger 0.1.0 [ALPHA-2026-06-14] — Behavioral Typing Logic for Java
1+
# FastKeylogger 0.1.0 [ALPHA-2026-06-14] — Behavioral Typing Logic for Java
22

33
[![Status](https://img.shields.io/badge/status-0.1.0-brightgreen.svg)](https://github.com/andrestubbe/FastKeylogger/releases/tag/0.1.0)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55
[![Java](https://img.shields.io/badge/Java-17+-blue.svg)](https://www.java.com)
66
[![Platform](https://img.shields.io/badge/Platform-Windows%2010+-lightgrey.svg)]()
77
[![JitPack](https://img.shields.io/badge/JitPack-ready-green.svg)](https://jitpack.io/#andrestubbe/FastKeylogger)
88

9-
---
10-
11-
**? Behavioral typing sensor and rhythm analysis layer for the FastJava ecosystem.**
9+
**🧠 Behavioral typing sensor and rhythm analysis layer for the FastJava ecosystem.**
1210

1311
FastKeylogger transforms raw hardware events into high-level **behavioral typing signatures**. While standard loggers
1412
only capture characters, FastKeylogger captures the **biological rhythm** (dwell times, flight times) and cognitive
1513
patterns (correction behavior) of the user.
1614

17-
---
18-
19-
[![FastKeyboard Showcase](docs/screenshot.png)](https://www.youtube.com/watch?v=BZsqQl7WqWk)
15+
[![FastKeylogger Showcase](docs/screenshot.png)](https://www.youtube.com/watch?v=BZsqQl7WqWk)
2016

2117
---
2218

2319
## Table of Contents
2420

2521
- [Key Features](#key-features)
2622
- [Installation](#installation)
23+
- [Quick Start](#quick-start)
2724
- [API Reference](#api-reference)
2825
- [Platform Support](#platform-support)
2926
- [License](#license)
3027
- [Related Projects](#related-projects)
3128

3229
---
3330

31+
## Quick Start
32+
3433
```java
3534
import fastkeylogger.FastKeylogger;
3635

@@ -51,10 +50,10 @@ public class Example {
5150

5251
## Key Features
5352

54-
- **?? Text Reconstruction** Converts raw hardware scancodes into a logical character stream.
55-
- **?? Timing Signatures** Captures precise **Dwell Time** (hold duration) and **Flight Time** (latency).
56-
- **?? Correction Awareness** Monitors backspaces and deletions to analyze cognitive load and error patterns.
57-
- **? Zero Polling** Purely event-driven logic based on `FastKeylogger`.
53+
- 📝 **Text Reconstruction** Converts raw hardware scancodes into a logical character stream.
54+
- ⏱️ **Timing Signatures** Captures precise **Dwell Time** (hold duration) and **Flight Time** (inter-key latency).
55+
- 🧠 **Correction Awareness** Monitors backspaces and deletions to analyze cognitive load and error patterns.
56+
- 🎯 **Zero Polling** Purely event-driven logic based on `FastKeyboard` raw input callbacks.
5857

5958
---
6059

@@ -65,7 +64,6 @@ public class Example {
6564
Add the JitPack repository and the dependencies to your `pom.xml`:
6665

6766
```xml
68-
6967
<repositories>
7068
<repository>
7169
<id>jitpack.io</id>
@@ -74,19 +72,19 @@ Add the JitPack repository and the dependencies to your `pom.xml`:
7472
</repositories>
7573

7674
<dependencies>
77-
<!-- FastKeylogger Library -->
78-
<dependency>
79-
<groupId>com.github.andrestubbe</groupId>
80-
<artifactId>fastkeylogger</artifactId>
81-
<version>0.1.0</version>
82-
</dependency>
83-
84-
<!-- FastCore (Required Native Loader) -->
85-
<dependency>
86-
<groupId>com.github.andrestubbe</groupId>
87-
<artifactId>fastcore</artifactId>
88-
<version>0.1.0</version>
89-
</dependency>
75+
<!-- FastKeylogger Library -->
76+
<dependency>
77+
<groupId>com.github.andrestubbe</groupId>
78+
<artifactId>FastKeylogger</artifactId>
79+
<version>0.1.0</version>
80+
</dependency>
81+
82+
<!-- FastCore (Required Native Loader) -->
83+
<dependency>
84+
<groupId>com.github.andrestubbe</groupId>
85+
<artifactId>FastCore</artifactId>
86+
<version>0.1.0</version>
87+
</dependency>
9088
</dependencies>
9189
```
9290

@@ -98,62 +96,57 @@ repositories {
9896
}
9997
10098
dependencies {
101-
implementation 'com.github.andrestubbe:fastkeylogger:0.1.0'
102-
implementation 'com.github.andrestubbe:fastcore:0.1.0'
99+
implementation 'com.github.andrestubbe:FastKeylogger:0.1.0'
100+
implementation 'com.github.andrestubbe:FastCore:0.1.0'
103101
}
104102
```
105103

106104
### Option 3: Direct Download (No Build Tool)
107105

108106
Download the latest JARs directly to add them to your classpath:
109107

110-
1. ?? *
111-
*[fastkeylogger-0.1.0.jar](https://github.com/andrestubbe/FastKeylogger/releases/download/0.1.0/fastkeylogger-0.1.0.jar)
112-
** (The Core Library)
113-
2. ?? **[fastcore-0.1.0.jar](https://github.com/andrestubbe/FastCore/releases/download/0.1.0/fastcore-0.1.0.jar)** (
114-
The Mandatory Native Loader)
108+
1. 📦 **[fastkeylogger-0.1.0.jar](https://github.com/andrestubbe/FastKeylogger/releases/download/0.1.0/fastkeylogger-0.1.0.jar)** (The Core Library)
109+
2. ⚙️ **[fastcore-0.1.0.jar](https://github.com/andrestubbe/FastCore/releases/download/0.1.0/fastcore-0.1.0.jar)** (The Mandatory Native Loader)
115110

116111
> [!IMPORTANT]
117112
> All JARs must be in your classpath for the native JNI calls to function correctly.
118113
114+
---
115+
119116
## API Reference
120117

121-
| Method | Description |
118+
| Method | Description |
122119
|------------------------------------|------------------------------------------------|
123-
| `void start()` | Starts the underlying keyboard listener. |
124-
| `void stop()` | Stops the listener and releases resources. |
120+
| `void start()` | Starts the underlying keyboard listener. |
121+
| `void stop()` | Stops the listener and releases resources. |
125122
| `void addListener(TypingListener)` | Registers a new observer for processed events. |
126123

127124
---
128125

129126
## Platform Support
130127

131-
| Platform | Status |
132-
|---------------------|-------------------|
133-
| Windows 10/11 (x64) | ? Fully Supported |
134-
| Linux | ?? Planned |
135-
| macOS | ?? Planned |
128+
| Platform | Status |
129+
|---------------------|--------------------|
130+
| Windows 10/11 (x64) | Fully Supported |
131+
| Linux | 🚧 Planned |
132+
| macOS | 🚧 Planned |
136133

137134
---
138135

139136
## License
140137

141-
MIT License See [LICENSE](LICENSE) file for details.
138+
MIT License See [LICENSE](LICENSE) file for details.
142139

143140
---
144141

145142
## Related Projects
146143

147-
- [FastCore](https://github.com/andrestubbe/FastCore) Native Library Loader & JNI Utilities for Java
148-
- [FastMouse](https://github.com/andrestubbe/FastMouse) � High-Performance Native Mouse API for Java
149-
- [FastHotkey](https://github.com/andrestubbe/FastHotkey) � Low-Latency Global Hotkey API for Java
150-
- [FastKeylogger](https://github.com/andrestubbe/FastKeylogger) � Native Windows RawInput API for Java
151-
- [FastTouch](https://github.com/andrestubbe/FastTouch) Native touchscreen input for Java
152-
- [FastStylus](https://github.com/andrestubbe/FastStylus) Native Stylus/Pen Input for Java
144+
- [FastCore](https://github.com/andrestubbe/FastCore) Native Library Loader & JNI Utilities for Java
145+
- [FastKeyboard](https://github.com/andrestubbe/FastKeyboard)Native Windows RawInput API for Java
146+
- [FastMouse](https://github.com/andrestubbe/FastMouse) — High-Performance Native Mouse API for Java
147+
- [FastHotkey](https://github.com/andrestubbe/FastHotkey) — Low-Latency Global Hotkey API for Java
148+
- [FastTouch](https://github.com/andrestubbe/FastTouch) Native Touchscreen Input for Java
149+
- [FastStylus](https://github.com/andrestubbe/FastStylus) Native Stylus/Pen Input for Java
153150

154151
---
155-
**Part of the FastJava Ecosystem***Making the JVM faster.*
156-
157-
158-
159-
152+
**Part of the FastJava Ecosystem***Making the JVM faster. ⚡*

0 commit comments

Comments
 (0)