Skip to content

Commit c755c10

Browse files
docs: lowercase readme prose with original badges
1 parent 904ed03 commit c755c10

1 file changed

Lines changed: 35 additions & 35 deletions

File tree

‎README.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# flow
44

5-
**Real-time network throughput in your terminal.**
5+
**real-time network throughput in your terminal.**
66

77
<img src="./assets/demo.png" alt="flow demo" width="100%">
88

@@ -33,8 +33,8 @@ brew install programmersd21/flow/flow
3333
go install github.com/programmersd21/flow/cmd/flow@latest
3434
```
3535

36-
Make sure `$(go env GOPATH)/bin` is on your `PATH`, otherwise your shell
37-
won't find the new binary (and a stale copy elsewhere can shadow it —
36+
make sure `$(go env gopath)/bin` is on your `path`, otherwise your shell
37+
won't find the new binary (and a stale copy elsewhere can shadow it ,
3838
`make install` warns about both).
3939

4040
`--version` reports the real release for every install method: builds carry an
@@ -57,8 +57,8 @@ flow --no-anim # disable animations (reduced motion)
5757
flow --format '↓ {{.Down}} ↑ {{.Up}}' # templated text output
5858
```
5959

60-
When stdout is not a TTY (a pipe, a script, a status bar) `flow` prints a
61-
single plain line instead of starting the TUI, so it is safe to pipe.
60+
when stdout is not a tty (a pipe, a script, a status bar) `flow` prints a
61+
single plain line instead of starting the tui, so it is safe to pipe.
6262

6363
### tmux
6464

@@ -68,23 +68,23 @@ set -g status-right "#(flow --tiny --no-color)"
6868

6969
### waybar / polybar / sketchybar / i3blocks
7070

71-
All of them can consume `flow --json-stream` or a fixed-width `--format` line.
72-
See [docs/integrations.md](docs/integrations.md) for copy-paste snippets.
71+
all of them can consume `flow --json-stream` or a fixed-width `--format` line.
72+
see [docs/integrations.md](docs/integrations.md) for copy-paste snippets.
7373

7474
## features
7575

76-
* **Mirrored Braille Waveform**: Download above the axis, upload below, rendered on a 2x4-dot braille canvas with a smooth interpolated crest
77-
* **Big Block Digits**: 5x5 bitmap hero numbers (timr-tui technique) — chunky enough to read at a glance, tabular so they never jitter
78-
* **Calm Motion**: Spring-driven value easing, an idle breathing pulse, a burst ripple, a pulsing link dot, a 180ms theme crossfade, and a skippable launch sequence — all disabled by `--no-anim`
79-
* **Time Windows**: `w` cycles 1m / 5m / 15m / 1h / 24h
80-
* **Scale Modes**: `S` cycles auto / linear / sqrt; `G` toggles the faint midpoint gridline
81-
* **Snapshot Export**: `s` writes the current frame as `.ansi` and `.txt`
82-
* **11 Built-in Themes**: `default`, `nord`, `dracula`, `gruvbox`, `forest`, `monochrome`, `catppuccin`, `tokyo-night`, `rose-pine`, `kanagawa`, `ansi`
83-
* **Custom TOML Themes**: Load custom color schemes from your config directory (see [docs/themes.md](docs/themes.md))
84-
* **Text Streams First**: `--json`, `--json-stream`, and `--format` (see [docs/json.md](docs/json.md))
85-
* **No telemetry**: The only network call flow makes is a latency probe to your configured ping target
86-
* **Cross-Platform**: Linux, macOS, and Windows, on amd64 and arm64, built without cgo
87-
* **Pipes cleanly**: Not a TTY means a single plain line, so status bars never receive escape codes
76+
* **mirrored braille waveform**: download above the axis, upload below, rendered on a 2x4-dot braille canvas with a smooth interpolated crest
77+
* **big block digits**: 5x5 bitmap hero numbers (timr-tui technique), chunky enough to read at a glance, tabular so they never jitter
78+
* **calm motion**: spring-driven value easing, an idle breathing pulse, a burst ripple, a pulsing link dot, a 180ms theme crossfade, and a skippable launch sequence, all disabled by `--no-anim`
79+
* **time windows**: `w` cycles 1m / 5m / 15m / 1h / 24h
80+
* **scale modes**: `s` cycles auto / linear / sqrt; `g` toggles the faint midpoint gridline
81+
* **snapshot export**: `s` writes the current frame as `.ansi` and `.txt`
82+
* **11 built-in themes**: `default`, `nord`, `dracula`, `gruvbox`, `forest`, `monochrome`, `catppuccin`, `tokyo-night`, `rose-pine`, `kanagawa`, `ansi`
83+
* **custom toml themes**: load custom color schemes from your config directory (see [docs/themes.md](docs/themes.md))
84+
* **text streams first**: `--json`, `--json-stream`, and `--format` (see [docs/json.md](docs/json.md))
85+
* **no telemetry**: the only network call flow makes is a latency probe to your configured ping target
86+
* **cross-platform**: linux, macos, and windows, on amd64 and arm64, built without cgo
87+
* **pipes cleanly**: not a tty means a single plain line, so status bars never receive escape codes
8888

8989
## keys
9090

@@ -96,25 +96,25 @@ See [docs/integrations.md](docs/integrations.md) for copy-paste snippets.
9696
| `t` | theme selector |
9797
| `n` | network processes inspector |
9898
| `i` | cycle network interface |
99-
| `I` | interface details |
100-
| `c` | cycle unit scale (auto / KB/s / MB/s / GB/s) |
99+
| `i` | interface details |
100+
| `c` | cycle unit scale (auto / kb/s / mb/s / gb/s) |
101101
| `b` | toggle bits/sec vs bytes/sec |
102102
| `+` / `-` | adjust sampling interval |
103103
| `p` | pause / resume sampling |
104104
| `r` | reset peak counters (press twice) |
105-
| `g` | open GitHub repository in browser |
106-
| `u` | open GitHub issues in browser |
107-
| `x` | open GitHub discussions in browser |
108-
| `$` / `v` | sponsor / donate on GitHub |
105+
| `g` | open github repository in browser |
106+
| `u` | open github issues in browser |
107+
| `x` | open github discussions in browser |
108+
| `$` / `v` | sponsor / donate on github |
109109
| `?` | help menu |
110110
| `w` | cycle time window (1m / 5m / 15m / 1h / 24h) |
111111
| `s` | export snapshot (`.ansi` + `.txt`) |
112-
| `S` | cycle graph scale (auto / linear / sqrt) |
113-
| `G` | toggle gridlines |
112+
| `s` | cycle graph scale (auto / linear / sqrt) |
113+
| `g` | toggle gridlines |
114114

115115
## configuration
116116

117-
Created automatically on first run:
117+
created automatically on first run:
118118

119119
```text
120120
Linux ~/.config/flow/config.toml
@@ -132,15 +132,15 @@ ping_target = "1.1.1.1"
132132
no_anim = false # disable animations
133133
```
134134

135-
### Environment variables
135+
### environment variables
136136

137137
| variable | effect |
138138
| -------- | ------ |
139-
| `NO_COLOR` | disable all ANSI color |
140-
| `FLOW_REDUCE_MOTION=1` | reduced motion, same as `--no-anim` |
141-
| `FLOW_CONFIG` | config file path (default: XDG config dir) |
142-
| `FLOW_DATA` | directory for persisted daily totals (default: XDG config dir) |
143-
| `FLOW_GLYPHS` | force `braille`, `blocks`, or `ascii` waveform glyphs |
139+
| `no_color` | disable all ansi color |
140+
| `flow_reduce_motion=1` | reduced motion, same as `--no-anim` |
141+
| `flow_config` | config file path (default: xdg config dir) |
142+
| `flow_data` | directory for persisted daily totals (default: xdg config dir) |
143+
| `flow_glyphs` | force `braille`, `blocks`, or `ascii` waveform glyphs |
144144

145145
## development
146146

@@ -152,4 +152,4 @@ make build
152152

153153
## license
154154

155-
MIT
155+
mit

0 commit comments

Comments
 (0)