From fa5b3d7f1eeaa13b82284e6c27ddc93c1d6f0f2d Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Thu, 27 Oct 2022 23:43:18 +0200
Subject: README: Add project description and usage information

---
 README.md | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 65e6824..e5eb8d7 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,22 @@
 SSVLSystemAlertVolume
 =====================
 
-TODO
-A library to access the system alert volume on Mac OS X. The alert volume 
-is/controls the percentage output volume
-for beeps and sound effects.
-is set relative to the output volume, and is used for beeps and sound effects.
+A library to access the system alert volume on Mac OS X. The alert volume is
+set relative to the output volume, and is used for beeps and sound effects.
 
-This volume level is commonly set in the System Preferences’ Sound preference pane. Under the pane’s “Sound Effects” tab, it is controlled using the “Alert volume” slider.
+This volume level is commonly set in the System Preferences’ Sound preference
+pane. Under the pane’s “Sound Effects” tab, it is controlled using the “Alert
+volume” slider.
+
+![Alert volume slider in the Sound preference pane](./Alert volume slider.png)
 
 
 ## Use
-TODO
+Include the two files “SSVLSystemAlertVolume.h” and “SSVLSystemAlertVolume.c”
+in your project directly, via submodule, or another means.
 
-[[See the example](./example/main.c) for …]
+[See the example](./example/main.c) for an illustration of how to use the
+library.
 
 
 ## License
-- 
cgit v1.2.3