summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTommaso Negri <me@tommasongr.com>2026-08-10 23:16:19 +0200
committerTommaso Negri <me@tommasongr.com>2026-08-10 23:16:19 +0200
commit00f35276d2541a97c08b0d63f2fa5ecb9df9ecb0 (patch)
tree6c694bf6ffec2a9a474bd1f5ebd11699a36e2072
parent9bb6d3ee8a1bfc66a709c88b0b2f2006e9b8dc0e (diff)
downloadbar-00f35276d2541a97c08b0d63f2fa5ecb9df9ecb0.tar.gz
bar-00f35276d2541a97c08b0d63f2fa5ecb9df9ecb0.zip
improve docs
-rw-r--r--Sources/bar/bar.docc/bar.md4
-rw-r--r--Sources/bar/bar.docc/bar.pngbin0 -> 616115 bytes
-rw-r--r--Sources/bar/bar.docc/how-it-works.md4
3 files changed, 5 insertions, 3 deletions
diff --git a/Sources/bar/bar.docc/bar.md b/Sources/bar/bar.docc/bar.md
index ae515a0..eb4ff73 100644
--- a/Sources/bar/bar.docc/bar.md
+++ b/Sources/bar/bar.docc/bar.md
@@ -1,9 +1,11 @@
# ``bar``
-Modular status bar for macOS written in Swift.
+Modular status bar for the Mac.
## Overview
+![bar](bar.png)
+
*bar* draws a status bar on each screen connected at runtime.
The bar can be configured to have a specific ``Config-swift.enum/height``, ``Config-swift.enum/position``, and ``Config-swift.enum/background`` color.
You can also customize the ``Config-swift.enum/font`` and ``Config-swift.enum/foreground`` color used by all the texts.
diff --git a/Sources/bar/bar.docc/bar.png b/Sources/bar/bar.docc/bar.png
new file mode 100644
index 0000000..1fcaacd
--- /dev/null
+++ b/Sources/bar/bar.docc/bar.png
Binary files differ
diff --git a/Sources/bar/bar.docc/how-it-works.md b/Sources/bar/bar.docc/how-it-works.md
index e81e40a..1ab5753 100644
--- a/Sources/bar/bar.docc/how-it-works.md
+++ b/Sources/bar/bar.docc/how-it-works.md
@@ -1,9 +1,9 @@
# How it works
-How *bar* works and how it differs from most macOS programs.
+How *bar* works and how it differs from most Mac programs.
*bar* design is heavily inspired by the suite of [*suckless* tools](https://suckless.org/) for Linux.
-These tools are vastly different from what you typically use on macOS.
+These tools are vastly different from what you typically use on the Mac.
They do not have configuration files, extraneous features, or a plugin/extension system.
Instead, they are focused on simplicity, frugality, and a DIY approach.