uttrflow / uttrflow/uttrflow-swift

README has no GIF of a dictation (screenshot landed in #61)

Open Beginner friendly
#54 1 comment 0 reactions 0 assignees View on GitHub
area:dictation area:docs documentation help wanted P2
Dominant language
Swift
Stars
4
Forks
17
Avg merge
4h 27m
Merged PRs (30d)
286

Description

## Why it matters

The README is text from the first line to the last. A visitor cannot see what the clipboard panel or the floating dictation button look like without building the app. Every comparable project in this niche opens with a picture or a short GIF, and it is the single strongest signal for whether someone stars, downloads or keeps scrolling.

## What to do

- One PNG of the clipboard panel with a few example entries (invented content — no real URLs, names or addresses; see `Scripts/pii_audit.sh`).
- One short GIF (under 3 MB) of a dictation: hold the key, speak, words land at the cursor.
- Place both directly under the badges, before *It runs without an account*.
- Commit them under `Docs/media/` and reference with relative paths so they render on GitHub and in forks.

Dark-mode captures are fine; the app has both.

Contributor guide

Open the contributing guide

Research direction

Start with the README and inspect the existing badges and the “It runs without an account” section to confirm the insertion point. Capture the clipboard panel and a short dictation GIF, save both under Docs/media/, run Scripts/pii_audit.sh, and verify the relative links render correctly on GitHub.

Written by the indexing model from the issue text.

Assessment

Tech stack
macos, swift
Domain
content, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.