From 4ab6c4f100e1f78f055952b301af7fffee844550 Mon Sep 17 00:00:00 2001 From: "Sam G." Date: Sun, 11 Aug 2024 04:13:39 -0700 Subject: [PATCH] modify argument names, update README with examples and demo --- README.md | 133 +++++++++++++++++++++++++++++++++------ docs/_static/example.gif | Bin 0 -> 14071605 bytes sym_tgt/test/aaa | 1 - sym_tgt/test/ccc | 1 - symconf/__main__.py | 13 ++-- 5 files changed, 121 insertions(+), 27 deletions(-) create mode 100644 docs/_static/example.gif delete mode 120000 sym_tgt/test/aaa delete mode 120000 sym_tgt/test/ccc diff --git a/README.md b/README.md index b428516..a23b08b 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,129 @@ # Symconf `symconf` is a CLI tool for managing local application configuration. It implements a general model that supports dynamically switching/reloading themes for any application, -and makes it easy to templatize your config files. +and provides a basic means of templatizing your config files. -## Quick example -The single command `symconf config -m dark -s gruvbox` indicates a dark mode preference and -that the `gruvbox` palette should be used. In this example, invoking this command kicks -off several app-specific process to update the system state: +## Simple example +Below is a simple example demonstrating two system-wide theme switches: + +![Simple example](docs/_static/example.gif) + +This GIF shows two `symconf` calls, the first of which applies a `gruvbox` dark theme and +the second a dark [`monobiome`][1] variant. Each call (of the form `symconf config -m dark -s +