Skip to content

Commit dce7b99

Browse files
rusmanplatdrusmanplatd
committed
0.0.7
1 parent 3796135 commit dce7b99

7 files changed

Lines changed: 415 additions & 9 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [0.0.7] - 2025-10-04
11+
1012
### Added
11-
- Global keyboard capture for all applications
13+
14+
- Global keyboard capture for all applications (Linux only)
1215
- Three layout modes: Vertical, Horizontal, and Wrapped
1316
- Configurable auto-hide duration for keypresses
1417
- Opacity control (10%-100%)
1518
- Font size adjustment (12px-32px)
1619
- Six predefined color themes (Default, Ocean, Forest, Sunset, Midnight, Monochrome)
1720
- Custom theme creator with color pickers
1821
- Settings persistence via localStorage
19-
- Draggable window via header
22+
- Draggable window via entire header
2023
- Window controls (minimize, close)
2124
- Always-on-top overlay window
2225
- Smart auto-scroll (only scrolls when at bottom)
@@ -25,21 +28,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2528
- Arrow keys display (↑ ↓ ← →)
2629
- Function keys support (F1-F12)
2730
- Special keys support (Enter, Backspace, Tab, Esc, etc.)
31+
- Professional app icon with keyboard design
32+
- Cross-platform builds (Linux, macOS, Windows)
33+
- GitHub Actions CI/CD pipeline
34+
- Automated releases via GitHub Actions
2835

2936
### Changed
37+
3038
- Default layout set to "Wrapped" mode for natural typing flow
3139
- Header now fully draggable (not just title)
3240
- Settings moved to collapsible panel
3341
- Direction toggle integrated into settings
42+
- Improved window z-index for proper always-on-top behavior
43+
- Visible on all workspaces/virtual desktops
3444

3545
### Fixed
46+
3647
- Smart scroll behavior prevents forced scrolling during manual navigation
3748
- Window control buttons properly prevent drag interference
3849
- Keyboard event handling optimized for lower CPU usage
50+
- Platform-specific dependencies (evdev Linux-only)
51+
- Cross-platform compilation support
3952

4053
## [0.1.0] - Initial Release
4154

4255
### Added
56+
4357
- Basic keyboard display functionality
4458
- Transparent overlay window
4559
- Tauri-based desktop application

‎RELEASE.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# ScreenKey v1.0.0 Release
2+
3+
## Release Steps
4+
5+
### 1. Commit all changes
6+
7+
```bash
8+
git add .
9+
git commit -m "Release v1.0.0"
10+
git push origin master
11+
```
12+
13+
### 2. Create and push the release tag
14+
15+
```bash
16+
git tag v1.0.0
17+
git push origin v1.0.0
18+
```
19+
20+
### 3. GitHub Actions will automatically:
21+
22+
- Build for Linux (AppImage, .deb)
23+
- Build for macOS (Intel + Apple Silicon DMG)
24+
- Build for Windows (MSI installer)
25+
- Create a GitHub Release with all binaries
26+
27+
### 4. Monitor the build
28+
29+
Visit: https://github.com/rusmanplatd/screenkey/actions
30+
31+
### 5. After build completes
32+
33+
- Go to: https://github.com/rusmanplatd/screenkey/releases
34+
- The draft release will be created with all installers attached
35+
- Edit the release notes if needed
36+
- Publish the release
37+
38+
## What Changed in v1.0.0
39+
40+
See [CHANGELOG.md](CHANGELOG.md) for full details.
41+
42+
### Highlights:
43+
44+
- ✨ Three layout modes (Vertical, Horizontal, Wrapped)
45+
- 🎨 Six predefined themes + custom theme creator
46+
- ⚙️ Comprehensive settings panel
47+
- 🖱️ Draggable window with minimize/close controls
48+
- 📏 Configurable font size and opacity
49+
- ⏱️ Auto-hide duration for keys
50+
- 🔝 Always-on-top with proper z-index
51+
- 🎯 Smart auto-scroll
52+
- 🖼️ Professional app icon
53+
- 🌐 Cross-platform builds (Linux, macOS, Windows)
54+
55+
## Platform Notes
56+
57+
### Linux
58+
59+
- **Full functionality** with global keyboard capture
60+
- Requires `sudo` or user in `input` group
61+
- Supports both X11 and Wayland
62+
63+
### macOS & Windows
64+
65+
- **Window and UI only** - keyboard capture not available
66+
- App will launch and display correctly
67+
- Shows warning message about Linux-only keyboard capture
68+
69+
## Installation
70+
71+
### Linux (Ubuntu/Debian)
72+
73+
```bash
74+
# Download .deb from releases
75+
sudo dpkg -i screenkey-app_1.0.0_amd64.deb
76+
77+
# Or use AppImage
78+
chmod +x ScreenKey_1.0.0_amd64.AppImage
79+
sudo ./ScreenKey_1.0.0_amd64.AppImage
80+
```
81+
82+
### macOS
83+
84+
```bash
85+
# Download and open DMG
86+
# Drag to Applications folder
87+
# Right-click > Open (first time only)
88+
```
89+
90+
### Windows
91+
92+
```bash
93+
# Download and run MSI installer
94+
# Follow installation wizard
95+
```
96+
97+
## Known Issues
98+
99+
- Keyboard capture only works on Linux (by design)
100+
- macOS and Windows versions are UI-only
101+
102+
## Future Plans
103+
104+
- Investigate keyboard capture for macOS/Windows
105+
- Add recording/export functionality
106+
- Custom key filtering
107+
- More themes and customization options

‎screenkey-app/package.json‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
{
22
"name": "screenkey-app",
3-
"version": "1.0.0",
3+
"version": "0.0.7",
44
"description": "A screencast tool to display keyboard inputs on screen",
55
"type": "module",
66
"scripts": {
77
"dev": "vite",
88
"build": "tsc && vite build",
99
"preview": "vite preview",
10-
"tauri": "tauri"
10+
"tauri": "tauri",
11+
"tauri:dev": "tauri dev",
12+
"tauri:build": "tauri build",
13+
"release": "node scripts/release.js",
14+
"release:major": "node scripts/release.js major",
15+
"release:minor": "node scripts/release.js minor",
16+
"release:patch": "node scripts/release.js patch"
1117
},
1218
"dependencies": {
1319
"react": "^19.2.0",

‎screenkey-app/scripts/README.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Release Scripts
2+
3+
## Quick Release
4+
5+
```bash
6+
# Patch release (1.0.0 -> 1.0.1)
7+
npm run release
8+
9+
# Or explicitly
10+
npm run release:patch
11+
```
12+
13+
## Version Bumping
14+
15+
```bash
16+
# Patch: 1.0.0 -> 1.0.1 (bug fixes)
17+
npm run release:patch
18+
19+
# Minor: 1.0.0 -> 1.1.0 (new features)
20+
npm run release:minor
21+
22+
# Major: 1.0.0 -> 2.0.0 (breaking changes)
23+
npm run release:major
24+
25+
# Custom version
26+
node scripts/release.js 2.5.0
27+
```
28+
29+
## What it does
30+
31+
The `npm run release` command will:
32+
33+
1. ✅ Check git status (fails if uncommitted changes)
34+
2. ✅ Calculate new version number
35+
3. ✅ Update `package.json`
36+
4. ✅ Update `src-tauri/tauri.conf.json`
37+
5. ✅ Update `src-tauri/Cargo.toml`
38+
6. ✅ Update `CHANGELOG.md` with release date
39+
7. ✅ Commit all changes
40+
8. ✅ Create git tag (e.g., `v1.0.1`)
41+
9. ✅ Push to GitHub (triggers release builds)
42+
43+
## GitHub Actions
44+
45+
After pushing the tag, GitHub Actions will automatically:
46+
47+
- 🏗️ Build for Linux (AppImage, .deb)
48+
- 🏗️ Build for macOS (Intel + Apple Silicon)
49+
- 🏗️ Build for Windows (MSI installer)
50+
- 📦 Create draft GitHub release
51+
- 📎 Attach all installers to the release
52+
53+
## Manual Steps After Release
54+
55+
1. Visit: https://github.com/rusmanplatd/screenkey/actions
56+
2. Wait for all builds to complete
57+
3. Go to: https://github.com/rusmanplatd/screenkey/releases
58+
4. Edit the draft release notes if needed
59+
5. Click "Publish release"
60+
61+
## Semantic Versioning
62+
63+
- **MAJOR** (1.0.0 -> 2.0.0): Breaking changes
64+
- **MINOR** (1.0.0 -> 1.1.0): New features, backwards compatible
65+
- **PATCH** (1.0.0 -> 1.0.1): Bug fixes, backwards compatible
66+
67+
## Example Workflow
68+
69+
```bash
70+
# Made some bug fixes
71+
npm run release:patch
72+
# Creates v1.0.1
73+
74+
# Added new features
75+
npm run release:minor
76+
# Creates v1.1.0
77+
78+
# Made breaking changes
79+
npm run release:major
80+
# Creates v2.0.0
81+
```
82+
83+
## Troubleshooting
84+
85+
### Error: Uncommitted changes
86+
87+
Make sure to commit all changes before releasing:
88+
89+
```bash
90+
git add .
91+
git commit -m "Your commit message"
92+
```
93+
94+
### Error: Tag already exists
95+
96+
Delete the tag locally and remotely:
97+
98+
```bash
99+
git tag -d v1.0.0
100+
git push origin :refs/tags/v1.0.0
101+
```
102+
103+
### Need to undo a release
104+
105+
If you haven't pushed yet:
106+
107+
```bash
108+
git reset --hard HEAD~1
109+
git tag -d v1.0.0
110+
```
111+
112+
If already pushed (not recommended):
113+
114+
```bash
115+
# Delete tag
116+
git push origin :refs/tags/v1.0.0
117+
# Force push to revert commit
118+
git reset --hard HEAD~1
119+
git push -f origin master
120+
```

0 commit comments

Comments
 (0)