From a0dba611fcc00fb38755c50fcf731738b6ea0c61 Mon Sep 17 00:00:00 2001
From: joncrall <jon.crall@kitware.com>
Date: Wed, 26 Feb 2025 10:45:38 -0500
Subject: [PATCH] doc: update readme

---
 README.rst | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/README.rst b/README.rst
index 7aee979..2e5c27b 100644
--- a/README.rst
+++ b/README.rst
@@ -17,9 +17,18 @@ ScriptConfig
 | Pypi             | https://pypi.org/project/scriptconfig            |
 +------------------+--------------------------------------------------+
 
-The goal of ``scriptconfig`` is to make it easy to be able to define a default
-configuration by **simply defining a dictionary**, and then allow that
-configuration to be modified by either:
+* Define concise CLI or function signatures.
+
+* Instantiate configs with YAML, cli-args, or kwargs.
+
+* Can generate equivalent argparse (can help to prototype and be replaced with pure-argparse).
+
+With ``scriptconfig``, define a flat key/value CLI with defaults using a
+dictionary or dataclass-like syntax. Values can simply be the default value, or
+a special ``scriptconfig.Value`` class that allows for metadata storage (e.g.
+help, positional, required, etc...). The configuration can instantiated by
+either:
+
 
 1. Updating it with another Python dictionary (e.g. ``kwargs``)
 2. Reading a YAML/JSON configuration file, or
-- 
GitLab